Update api docs (#116495)

* update api docs

* update api docs
This commit is contained in:
Stacey Gammon 2021-11-01 15:16:16 -04:00 committed by GitHub
parent 7bd984ba46
commit 4bfb35b43a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
123 changed files with 13024 additions and 10093 deletions

View file

@ -368,7 +368,7 @@
"label": "validate",
"description": [],
"signature": [
"{ params?: ValidatorType<Params> | undefined; config?: ValidatorType<Config> | undefined; secrets?: ValidatorType<Secrets> | undefined; } | undefined"
"{ params?: ValidatorType<Params> | undefined; config?: ValidatorType<Config> | undefined; secrets?: ValidatorType<Secrets> | undefined; connector?: ((config: Config, secrets: Secrets) => string | null) | undefined; } | undefined"
],
"path": "x-pack/plugins/actions/server/types.ts",
"deprecated": false
@ -695,7 +695,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"info\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
"{ readonly source?: string | undefined; readonly group?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"info\" | \"error\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
"deprecated": false,
@ -709,7 +709,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
"{ readonly message: string; readonly level: \"info\" | \"error\" | \"trace\" | \"debug\" | \"warn\" | \"fatal\"; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
"deprecated": false,

View file

@ -24,7 +24,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
@ -55,7 +55,7 @@
"section": "def-common.AlertAction",
"text": "AlertAction"
},
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ",
"[]; alertTypeId: string; consumer: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
@ -63,7 +63,7 @@
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
@ -332,7 +332,7 @@
"id": "def-server.AlertingAuthorization.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n auditLogger,\n getSpace,\n getSpaceId,\n }",
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n getSpace,\n getSpaceId,\n }",
"description": [],
"signature": [
"ConstructorOptions"
@ -531,7 +531,7 @@
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
@ -623,7 +623,7 @@
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
@ -1038,7 +1038,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
@ -1676,7 +1676,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false
@ -2137,7 +2137,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
"<Params>, \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
@ -2181,7 +2181,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: ",
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: ",
"FindOptions",
" | undefined; }) => Promise<",
{
@ -2199,9 +2199,9 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> | Pick<",
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> | Pick<",
"AlertWithLegacyId",
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\" | \"legacyId\">>; resolve: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<",
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\" | \"legacyId\">>; resolve: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
@ -3405,6 +3405,19 @@
],
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertInstanceSummary.executionDuration",
"type": "Object",
"tags": [],
"label": "executionDuration",
"description": [],
"signature": [
"{ average: number; values: number[]; }"
],
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -4153,7 +4166,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> & Pick<",
"<Params>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> & Pick<",
{
"pluginId": "core",
"scope": "server",
@ -4183,7 +4196,7 @@
"section": "def-common.AlertAction",
"text": "AlertAction"
},
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ",
"[]; alertTypeId: string; consumer: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
@ -4191,7 +4204,7 @@
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
@ -4221,7 +4234,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/common/alert.ts",
"deprecated": false,

View file

@ -18,7 +18,7 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 257 | 0 | 249 | 17 |
| 258 | 0 | 250 | 17 |
## Client

File diff suppressed because one or more lines are too long

View file

@ -3512,7 +3512,7 @@
"label": "outcome",
"description": [],
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
"\"conflict\" | \"aliasMatch\" | \"exactMatch\""
],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
@ -5492,7 +5492,7 @@
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }; outcome: \"conflict\" | \"exactMatch\" | \"aliasMatch\"; } & { alias_target_id?: string | undefined; }"
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }; outcome: \"conflict\" | \"aliasMatch\" | \"exactMatch\"; } & { alias_target_id?: string | undefined; }"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,

View file

@ -3842,6 +3842,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-common.LEGACY_TIME_AXIS",
"type": "string",
"tags": [],
"label": "LEGACY_TIME_AXIS",
"description": [],
"signature": [
"\"visualization:useLegacyTimeAxis\""
],
"path": "src/plugins/charts/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-common.paletteIds",

View file

@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 285 | 4 | 253 | 3 |
| 286 | 4 | 254 | 3 |
## Client

View file

@ -32,6 +32,43 @@
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.setup",
@ -50,23 +87,14 @@
},
"<object, unknown>, { devTools, home, share, usageCollection }: ",
"AppSetupUIPluginDependencies",
") => { locator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
") => ",
{
"pluginId": "console",
"scope": "public",
"docId": "kibConsolePluginApi",
"section": "def-public.ConsoleUILocatorParams",
"text": "ConsoleUILocatorParams"
},
">; }"
"section": "def-public.ConsolePluginSetup",
"text": "ConsolePluginSetup"
}
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
@ -130,6 +158,47 @@
],
"functions": [],
"interfaces": [
{
"parentPluginId": "console",
"id": "def-public.ConsolePluginSetup",
"type": "Interface",
"tags": [],
"label": "ConsolePluginSetup",
"description": [],
"path": "src/plugins/console/public/types/plugin_dependencies.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "console",
"id": "def-public.ConsolePluginSetup.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "console",
"scope": "public",
"docId": "kibConsolePluginApi",
"section": "def-public.ConsoleUILocatorParams",
"text": "ConsoleUILocatorParams"
},
"> | undefined"
],
"path": "src/plugins/console/public/types/plugin_dependencies.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "console",
"id": "def-public.ConsoleUILocatorParams",
@ -154,7 +223,7 @@
"text": "SerializableRecord"
}
],
"path": "src/plugins/console/public/plugin.ts",
"path": "src/plugins/console/public/types/locator.ts",
"deprecated": false,
"children": [
{
@ -167,7 +236,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/console/public/plugin.ts",
"path": "src/plugins/console/public/types/locator.ts",
"deprecated": false
}
],

View file

@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 9 | 1 |
| 13 | 0 | 13 | 1 |
## Client

File diff suppressed because one or more lines are too long

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2298 | 27 | 1018 | 29 |
| 2304 | 27 | 1022 | 29 |
## Client

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2298 | 27 | 1018 | 29 |
| 2304 | 27 | 1022 | 29 |
## Client

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2298 | 27 | 1018 | 29 |
| 2304 | 27 | 1022 | 29 |
## Client

View file

@ -2286,7 +2286,7 @@
"\nReadonly copy of incoming request headers."
],
"signature": [
"{ from?: string | string[] | undefined; date?: string | string[] | undefined; origin?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
"{ from?: string | string[] | undefined; date?: string | string[] | undefined; origin?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
],
"path": "src/core/server/http/router/request.ts",
"deprecated": false
@ -2697,7 +2697,7 @@
"\nHeaders to attach for auth redirect.\nMust include \"location\" header"
],
"signature": [
"({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)"
"({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)"
],
"path": "src/core/server/http/lifecycle/auth.ts",
"deprecated": false
@ -2863,7 +2863,7 @@
"\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'"
],
"signature": [
"(headers: ({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)) => ",
"(headers: ({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)) => ",
{
"pluginId": "core",
"scope": "server",
@ -2883,7 +2883,7 @@
"label": "headers",
"description": [],
"signature": [
"({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)"
"({ location: string; } & Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record<string, string | string[]>)"
],
"path": "src/core/server/http/lifecycle/auth.ts",
"deprecated": false,
@ -2942,7 +2942,7 @@
"HTTP Headers with additional information about response"
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/router/response.ts",
"deprecated": false
@ -3012,7 +3012,7 @@
"HTTP Headers with additional information about response"
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/router/response.ts",
"deprecated": false
@ -3172,7 +3172,7 @@
"HTTP Headers with additional information about response"
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/router/response.ts",
"deprecated": false
@ -7505,7 +7505,7 @@
"additional headers to attach to the response"
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/lifecycle/on_pre_response.ts",
"deprecated": false
@ -7560,7 +7560,7 @@
"additional headers to attach to the response"
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/lifecycle/on_pre_response.ts",
"deprecated": false
@ -9252,7 +9252,7 @@
"\nHttp request headers to read."
],
"signature": [
"{ from?: string | string[] | undefined; date?: string | string[] | undefined; origin?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
"{ from?: string | string[] | undefined; date?: string | string[] | undefined; origin?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
],
"path": "src/core/server/http/router/headers.ts",
"deprecated": false,
@ -9595,7 +9595,7 @@
"\nSet of well-known HTTP headers."
],
"signature": [
"\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\""
"\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\""
],
"path": "src/core/server/http/router/headers.ts",
"deprecated": false,
@ -11965,7 +11965,7 @@
"\nHttp response headers to set."
],
"signature": [
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]>"
"Record<\"from\" | \"date\" | \"origin\" | \"range\" | \"warning\" | \"location\" | \"allow\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]>"
],
"path": "src/core/server/http/router/headers.ts",
"deprecated": false,

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2298 | 27 | 1018 | 29 |
| 2304 | 27 | 1022 | 29 |
## Client

View file

@ -1073,7 +1073,7 @@
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
],
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
"\"conflict\" | \"aliasMatch\" | \"exactMatch\""
],
"path": "src/core/public/saved_objects/types.ts",
"deprecated": false
@ -4426,51 +4426,6 @@
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError",
"type": "Function",
"tags": [],
"label": "createGenericNotFoundEsUnavailableError",
"description": [],
"signature": [
"(type?: string | null, id?: string | null) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -14079,7 +14034,7 @@
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
],
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
"\"conflict\" | \"aliasMatch\" | \"exactMatch\""
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
@ -14280,6 +14235,23 @@
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.getKibanaIndex",
"type": "Function",
"tags": [],
"label": "getKibanaIndex",
"description": [
"\nReturns the default index used for saved objects."
],
"signature": [
"() => string"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
@ -15510,7 +15482,7 @@
},
"<T> extends Pick<",
"SavedObject",
"<T>, \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">"
"<T>, \"type\" | \"id\" | \"version\" | \"namespaces\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"error\" | \"updated_at\" | \"originId\">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
@ -16789,6 +16761,10 @@
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingHistogramProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDenseVectorProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingAggregateMetricDoubleProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingObjectProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingNestedProperty",
@ -16807,7 +16783,23 @@
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingKeywordProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingNumberProperty",
"MappingFloatNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingHalfFloatNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingIntegerNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingLongNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingShortNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingByteNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingUnsignedLongNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingScaledFloatNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingLongRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2298 | 27 | 1018 | 29 |
| 2304 | 27 | 1022 | 29 |
## Client

View file

@ -387,7 +387,7 @@
"label": "categories",
"description": [],
"signature": [
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -400,7 +400,7 @@
"label": "shipper",
"description": [],
"signature": [
"\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -434,7 +434,7 @@
"\nA category applicable to an Integration."
],
"signature": [
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -646,7 +646,7 @@
"label": "categories",
"description": [],
"signature": [
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -659,7 +659,7 @@
"label": "shipper",
"description": [],
"signature": [
"\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -748,7 +748,7 @@
"label": "id",
"description": [],
"signature": [
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -769,7 +769,7 @@
"\nThe list of all available categories."
],
"signature": [
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
"(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -785,7 +785,7 @@
"\nA category applicable to an Integration."
],
"signature": [
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
"\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communication\" | \"customer_support\" | \"document_storage\" | \"enterprise_management\" | \"knowledge_platform\" | \"language_client\" | \"project_management\" | \"software_development\" | \"upload_file\" | \"website_search\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -851,7 +851,7 @@
"\nThe list of all known shippers."
],
"signature": [
"(\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\")[]"
"(\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -867,7 +867,7 @@
"\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration."
],
"signature": [
"\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -1129,16 +1129,56 @@
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.communication",
"type": "string",
"tags": [],
"label": "upload_file",
"label": "communication",
"description": [
"// Kibana added"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.customer_support",
"type": "string",
"tags": [],
"label": "customer_support",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.document_storage",
"type": "string",
"tags": [],
"label": "document_storage",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.enterprise_management",
"type": "string",
"tags": [],
"label": "enterprise_management",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.knowledge_platform",
"type": "string",
"tags": [],
"label": "knowledge_platform",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.language_client",
@ -1148,6 +1188,46 @@
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.project_management",
"type": "string",
"tags": [],
"label": "project_management",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.software_development",
"type": "string",
"tags": [],
"label": "software_development",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file",
"type": "string",
"tags": [],
"label": "upload_file",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.INTEGRATION_CATEGORY_DISPLAY.website_search",
"type": "string",
"tags": [],
"label": "website_search",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -1174,6 +1254,16 @@
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.SHIPPER_DISPLAY.enterprise_search",
"type": "string",
"tags": [],
"label": "enterprise_search",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.SHIPPER_DISPLAY.language_clients",

View file

@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 91 | 1 | 75 | 1 |
| 100 | 1 | 84 | 1 |
## Client

View file

@ -61,6 +61,26 @@
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.controlGroup",
"type": "Object",
"tags": [],
"label": "controlGroup",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupContainer",
"text": "ControlGroupContainer"
},
" | undefined"
],
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getPanelCount",
@ -159,6 +179,35 @@
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.Unnamed.$4",
"type": "CompoundType",
"tags": [],
"label": "controlGroup",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupContainer",
"text": "ControlGroupContainer"
},
" | ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
" | undefined"
],
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
@ -472,7 +521,7 @@
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>, embeddableId?: string | undefined) => Promise<void | E | ",
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>, embeddableId?: string | undefined) => Promise<void | ",
{
"pluginId": "embeddable",
"scope": "public",
@ -480,7 +529,7 @@
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
">"
" | E>"
],
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false,
@ -560,6 +609,21 @@
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getInheritedInput",
@ -1159,6 +1223,20 @@
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.controlGroupInput",
"type": "Object",
"tags": [],
"label": "controlGroupInput",
"description": [],
"signature": [
"DashboardControlGroupInput",
" | undefined"
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.refreshConfig",
@ -1807,6 +1885,45 @@
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardSavedObject.outcome",
"type": "string",
"tags": [],
"label": "outcome",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardSavedObject.aliasId",
"type": "string",
"tags": [],
"label": "aliasId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardSavedObject.controlGroupInput",
"type": "Object",
"tags": [],
"label": "controlGroupInput",
"description": [],
"signature": [
"{ controlStyle?: \"twoLine\" | \"oneLine\" | undefined; panelsJSON?: string | undefined; } | undefined"
],
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -2820,6 +2937,20 @@
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerStateWithType.controlGroupInput",
"type": "Object",
"tags": [],
"label": "controlGroupInput",
"description": [],
"signature": [
"DashboardContainerControlGroupInput",
" | undefined"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false
}
],
"initialIsOpen": false

View file

@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 145 | 1 | 132 | 10 |
| 153 | 1 | 140 | 12 |
## Client

File diff suppressed because it is too large Load diff

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 |
|-------------------|-----------|------------------------|-----------------|
| 3193 | 43 | 2807 | 48 |
| 3238 | 40 | 2848 | 48 |
## Client

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 |
|-------------------|-----------|------------------------|-----------------|
| 3193 | 43 | 2807 | 48 |
| 3238 | 40 | 2848 | 48 |
## Client

View file

@ -27,13 +27,13 @@
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
">"
"[]>"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false,
@ -570,28 +570,124 @@
{
"parentPluginId": "data",
"id": "def-public.FilterManager.extract",
"type": "Any",
"type": "Function",
"tags": [],
"label": "extract",
"description": [],
"signature": [
"any"
"(filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => { state: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; references: ",
"SavedObjectReference",
"[]; }"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.extract.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/data/common/query/persistable_state.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.inject",
"type": "Any",
"type": "Function",
"tags": [],
"label": "inject",
"description": [],
"signature": [
"any"
"(filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], references: ",
"SavedObjectReference",
"[]) => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.inject.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/data/common/query/persistable_state.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.inject.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[]"
],
"path": "src/plugins/data/common/query/persistable_state.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
@ -603,13 +699,13 @@
"signature": [
"(filters: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
", collector: unknown) => {}"
"[], collector: unknown) => {}"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false,
@ -618,18 +714,19 @@
{
"parentPluginId": "data",
"id": "def-public.FilterManager.telemetry.$1",
"type": "Object",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/data/common/query/persistable_state.ts",
"deprecated": false
@ -649,19 +746,6 @@
}
]
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.migrateToLatest",
"type": "Any",
"tags": [],
"label": "migrateToLatest",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getAllMigrations",
@ -670,7 +754,14 @@
"label": "getAllMigrations",
"description": [],
"signature": [
"() => {}"
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
}
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"deprecated": false,
@ -835,15 +926,47 @@
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"; state$: ",
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }; state$: ",
"Observable",
"<{ changes: ",
{
@ -964,15 +1087,47 @@
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"; state$: ",
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }; state$: ",
"Observable",
"<{ changes: ",
{
@ -1159,22 +1314,55 @@
"label": "createSavedQueryService",
"description": [],
"signature": [
"(savedObjectsClient: Pick<",
"(http: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
},
", \"create\" | \"bulkCreate\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"bulkUpdate\">) => ",
") => { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
}
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }"
],
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"deprecated": false,
@ -1184,18 +1372,16 @@
"id": "def-public.createSavedQueryService.$1",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"label": "http",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"bulkUpdate\">"
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"deprecated": false,
@ -1556,15 +1742,47 @@
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"; state$: ",
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }; state$: ",
"Observable",
"<{ changes: ",
{
@ -1677,15 +1895,47 @@
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"; state$: ",
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }; state$: ",
"Observable",
"<{ changes: ",
{
@ -1985,15 +2235,15 @@
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.saveQuery",
"id": "def-public.SavedQueryService.createQuery",
"type": "Function",
"tags": [],
"label": "saveQuery",
"label": "createQuery",
"description": [],
"signature": [
"(attributes: ",
"SavedQueryAttributes",
", config?: { overwrite: boolean; } | undefined) => Promise<",
") => Promise<",
{
"pluginId": "data",
"scope": "public",
@ -2008,7 +2258,7 @@
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.saveQuery.$1",
"id": "def-public.SavedQueryService.createQuery.$1",
"type": "Object",
"tags": [],
"label": "attributes",
@ -2019,28 +2269,60 @@
"path": "src/plugins/data/public/query/saved_query/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.updateQuery",
"type": "Function",
"tags": [],
"label": "updateQuery",
"description": [],
"signature": [
"(id: string, attributes: ",
"SavedQueryAttributes",
") => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">"
],
"path": "src/plugins/data/public/query/saved_query/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.updateQuery.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/public/query/saved_query/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.saveQuery.$2",
"id": "def-public.SavedQueryService.updateQuery.$2",
"type": "Object",
"tags": [],
"label": "config",
"label": "attributes",
"description": [],
"signature": [
"SavedQueryAttributes"
],
"path": "src/plugins/data/public/query/saved_query/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.saveQuery.$2.overwrite",
"type": "boolean",
"tags": [],
"label": "overwrite",
"description": [],
"path": "src/plugins/data/public/query/saved_query/types.ts",
"deprecated": false
}
]
"isRequired": true
}
],
"returnComment": []
@ -2265,15 +2547,47 @@
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: { createQuery: (attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<any>; updateQuery: (id: string, attributes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
") => Promise<any>; getAllSavedQueries: () => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"; state$: ",
"[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>; getSavedQuery: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">; deleteSavedQuery: (id: string) => Promise<any>; getSavedQueryCount: () => Promise<number>; }; state$: ",
"Observable",
"<{ changes: ",
{
@ -3059,6 +3373,134 @@
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-common.SavedQuery",
"type": "Interface",
"tags": [],
"label": "SavedQuery",
"description": [],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedQuery.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQuery.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryAttributes",
"text": "SavedQueryAttributes"
}
],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes",
"type": "Interface",
"tags": [],
"label": "SavedQueryAttributes",
"description": [],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryAttributes.timefilter",
"type": "CompoundType",
"tags": [],
"label": "timefilter",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.SavedQueryTimeFilter",
"text": "SavedQueryTimeFilter"
},
" | undefined"
],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRangeBounds",
@ -3115,6 +3557,35 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedQueryTimeFilter",
"type": "Type",
"tags": [],
"label": "SavedQueryTimeFilter",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" & { refreshInterval: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
"; }"
],
"path": "src/plugins/data/common/query/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRange",

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 |
|-------------------|-----------|------------------------|-----------------|
| 3193 | 43 | 2807 | 48 |
| 3238 | 40 | 2848 | 48 |
## Client

File diff suppressed because it is too large Load diff

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 |
|-------------------|-----------|------------------------|-----------------|
| 3193 | 43 | 2807 | 48 |
| 3238 | 40 | 2848 | 48 |
## Client

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 |
|-------------------|-----------|------------------------|-----------------|
| 3193 | 43 | 2807 | 48 |
| 3238 | 40 | 2848 | 48 |
## Client

File diff suppressed because it is too large Load diff

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 |
|-------------------|-----------|------------------------|-----------------|
| 683 | 6 | 541 | 5 |
| 668 | 5 | 526 | 5 |
## Client

View file

@ -954,6 +954,56 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.applicationPath",
"type": "string",
"tags": [],
"label": "applicationPath",
"description": [],
"path": "x-pack/plugins/data_visualizer/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"\"file_data_visualizer\""
],
"path": "x-pack/plugins/data_visualizer/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.featureTitle",
"type": "string",
"tags": [],
"label": "featureTitle",
"description": [],
"path": "x-pack/plugins/data_visualizer/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FILE_DATA_VIS_TAB_ID",
"type": "string",
"tags": [],
"label": "FILE_DATA_VIS_TAB_ID",
"description": [],
"signature": [
"\"fileDataViz\""
],
"path": "x-pack/plugins/data_visualizer/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FILE_SIZE_DISPLAY_FORMAT",

View file

@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 80 | 5 | 80 | 0 |
| 84 | 5 | 84 | 0 |
## Client

View file

@ -16,9 +16,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDashboardPluginApi" section="def-public.DashboardStart.dashboardUrlGenerator" text="dashboardUrlGenerator"/> | securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | dataViews, visTypeTimeseries, reporting, discover, observability, maps, dataVisualizer, apm, lens, osquery, securitySolution, transform, savedObjects, indexPatternFieldEditor, visualizations, dashboard, graph, stackAlerts, uptime, indexPatternEditor, indexPatternManagement, inputControlVis, savedObjectsManagement, visualize, visDefaultEditor, visTypeVega, data | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternField" text="IndexPatternField"/> | dataViews, discover, maps, dataVisualizer, lens, indexPatternFieldEditor, securitySolution, indexPatternEditor, indexPatternManagement, inputControlVis, visDefaultEditor, visTypeTimeseries, data | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | dataViews, timelines, monitoring, securitySolution, indexPatternManagement, presentationUtil, stackAlerts, transform | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | dataViews, timelines, monitoring, securitySolution, indexPatternManagement, stackAlerts, transform | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | home, savedObjects, security, fleet, indexPatternFieldEditor, discover, dashboard, lens, observability, maps, fileUpload, dataVisualizer, ml, infra, graph, monitoring, osquery, securitySolution, stackAlerts, transform, upgradeAssistant, uptime, indexPatternEditor, indexPatternManagement, inputControlVis, kibanaOverview, savedObjectsManagement, visualize, visTypeTimelion, visTypeTimeseries, visTypeVega | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | dataViews, timelines, monitoring, securitySolution, indexPatternManagement, presentationUtil, stackAlerts, transform, data | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | dataViews, timelines, monitoring, securitySolution, indexPatternManagement, stackAlerts, transform, data | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternField" text="IndexPatternField"/> | dataViews, discover, maps, dataVisualizer, lens, indexPatternFieldEditor, securitySolution, indexPatternEditor, indexPatternManagement, inputControlVis, visDefaultEditor, visTypeTimeseries, data | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | dataViews, visTypeTimeseries, reporting, discover, observability, maps, dataVisualizer, apm, lens, osquery, securitySolution, transform, savedObjects, indexPatternFieldEditor, visualizations, dashboard, graph, stackAlerts, uptime, indexPatternEditor, indexPatternManagement, inputControlVis, savedObjectsManagement, visualize, visDefaultEditor, visTypeVega, data | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternField" text="IndexPatternField"/> | dataViews, discover, maps, dataVisualizer, lens, indexPatternFieldEditor, securitySolution, indexPatternEditor, indexPatternManagement, inputControlVis, visDefaultEditor, visTypeTimeseries | - |
@ -94,25 +94,24 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas, visTypeXy | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, enterpriseSearch, savedObjectsTagging | - |
| <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | ml | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | encryptedSavedObjects, actions, alerting | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console | - |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesPluginSetup.spacesService" text="spacesService"/> | security, reporting, apm, infra, securitySolution | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.getSpaceId" text="getSpaceId"/> | security, reporting, apm, infra, securitySolution | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.namespaceToSpaceId" text="namespaceToSpaceId"/> | security | 7.16 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | discover, visualizations, dashboard, lens, observability, maps, dashboardEnhanced, discoverEnhanced, securitySolution, visualize, presentationUtil | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | lens, timelines, infra, securitySolution, stackAlerts, transform, indexPatternManagement, visTypeTimelion, visTypeVega | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | discover, visualizations, dashboard, lens, observability, maps, dashboardEnhanced, discoverEnhanced, securitySolution, visualize | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | lens, timelines, securitySolution, stackAlerts, transform, indexPatternManagement, visTypeTimelion, visTypeVega | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement, presentationUtil | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement, presentationUtil, data | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement, data | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.intervalName" text="intervalName"/> | dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.addScriptedField" text="addScriptedField"/> | dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.removeScriptedField" text="removeScriptedField"/> | indexPatternManagement, dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, indexPatternManagement, dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getScriptedFields" text="getScriptedFields"/> | dataViews, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement, presentationUtil | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | dataViews, fleet, infra, monitoring, stackAlerts, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.intervalName" text="intervalName"/> | dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.addScriptedField" text="addScriptedField"/> | dataViews | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.removeScriptedField" text="removeScriptedField"/> | indexPatternManagement, dataViews | 8.1 |
@ -231,7 +230,6 @@ Safe to remove.
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> |
| <DocLink id="kibLicensingPluginApi" section="def-server.ILicense.mode" text="mode"/> |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> |
| <DocLink id="kibSecurityPluginApi" section="def-public.SecurityLicenseFeatures.allowLegacyAuditLogging" text="allowLegacyAuditLogging"/> |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.spaceIdToNamespace" text="spaceIdToNamespace"/> |
| <DocLink id="kibTimelinesPluginApi" section="def-common.InProgressStatus" text="InProgressStatus"/> |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportFailure.title" text="title"/> |

View file

@ -15,7 +15,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-common.nodeBuilder" text="nodeBuilder"/> | [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder) | 8.1 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authc) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authz) | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - |
@ -40,7 +39,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.KueryNode" text="KueryNode"/> | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.KueryNode" text="KueryNode"/> | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [rules_client_factory.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client_factory.test.ts#:~:text=LegacyAuditLogger), [rules_client_factory.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client_factory.test.ts#:~:text=LegacyAuditLogger) | - |
@ -226,7 +224,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternListItem" text="IndexPatternListItem"/> | [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=IndexPatternListItem), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternListItem) | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.intervalName" text="intervalName"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [update_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/update_index_pattern.ts#:~:text=intervalName), [update_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/update_index_pattern.ts#:~:text=intervalName) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.addScriptedField" text="addScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.addScriptedField" text="addScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.removeScriptedField" text="removeScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getScriptedFields" text="getScriptedFields"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields)+ 1 more | 8.1 |
@ -237,7 +235,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternsService" text="IndexPatternsService"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.intervalName" text="intervalName"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=intervalName), [update_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/update_index_pattern.ts#:~:text=intervalName), [update_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/update_index_pattern.ts#:~:text=intervalName) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.flattenHit" text="flattenHit"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.addScriptedField" text="addScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.addScriptedField" text="addScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=addScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.removeScriptedField" text="removeScriptedField"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getScriptedFields" text="getScriptedFields"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields)+ 1 more | 8.1 |
@ -321,7 +319,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts#:~:text=LegacyAuditLogger) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [encryption_key_rotation_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_key_rotation_service.ts#:~:text=authc), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#:~:text=authc) | - |
@ -471,7 +468,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [custom_metric_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx#:~:text=IFieldType), [custom_metric_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx#:~:text=IFieldType), [custom_field_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx#:~:text=IFieldType), [custom_field_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx#:~:text=IFieldType), [waffle_group_by_controls.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx#:~:text=IFieldType), [waffle_group_by_controls.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx#:~:text=IFieldType), [metric.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx#:~:text=IFieldType), [metric.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx#:~:text=IFieldType)+ 46 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [editor.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [logs_overview_fetchers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts#:~:text=indexPatterns), [redirect_to_node_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx#:~:text=indexPatterns), [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns), [page_providers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_providers.tsx#:~:text=indexPatterns), [logs_overview_fetches.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetches.test.ts#:~:text=indexPatterns) | - |
| <DocLink id="kibDataPluginApi" section="def-public.esKuery" text="esKuery"/> | [kuery_bar.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/kuery_bar.tsx#:~:text=esKuery), [kuery_bar.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/kuery_bar.tsx#:~:text=esKuery), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/kuery.ts#:~:text=esKuery), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/kuery.ts#:~:text=esKuery), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/kuery.ts#:~:text=esKuery), [use_waffle_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/hooks/use_waffle_filters.ts#:~:text=esKuery), [use_waffle_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/hooks/use_waffle_filters.ts#:~:text=esKuery) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/logs/log_stream/index.ts#:~:text=esQuery), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/logs/log_stream/index.ts#:~:text=esQuery), [log_filter_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts#:~:text=esQuery), [log_filter_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts#:~:text=esQuery), [log_filter_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts#:~:text=esQuery) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=Filter), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [custom_metric_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx#:~:text=IFieldType), [custom_metric_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx#:~:text=IFieldType), [custom_field_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx#:~:text=IFieldType), [custom_field_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx#:~:text=IFieldType), [waffle_group_by_controls.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx#:~:text=IFieldType), [waffle_group_by_controls.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx#:~:text=IFieldType), [metric.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx#:~:text=IFieldType), [metric.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx#:~:text=IFieldType)+ 102 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=Filter), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter), [use_dataset_filtering.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_dataset_filtering.ts#:~:text=Filter) | 8.1 |
@ -595,19 +591,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternsService" text="IndexPatternsService"/> | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternsContract" text="IndexPatternsContract"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern)+ 206 more | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField)+ 268 more | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 272 more | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [kibana_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/kibana_services.ts#:~:text=indexPatterns) | - |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=esFilters), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=esFilters), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=esFilters), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=esFilters), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=esFilters), [es_geo_line_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_line_source/es_geo_line_source.tsx#:~:text=esFilters), [es_geo_line_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_line_source/es_geo_line_source.tsx#:~:text=esFilters), [es_geo_line_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_line_source/es_geo_line_source.tsx#:~:text=esFilters), [app_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/app_sync.ts#:~:text=esFilters), [app_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/app_sync.ts#:~:text=esFilters)+ 9 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=Filter), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=Filter), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=Filter), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=Filter), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=Filter)+ 115 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField)+ 268 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 272 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternsService" text="IndexPatternsService"/> | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternsContract" text="IndexPatternsContract"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern)+ 206 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=Filter), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#:~:text=Filter), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=Filter), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=Filter), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=Filter), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=Filter)+ 115 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_tooltip_property.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField), [es_doc_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IndexPatternField)+ 129 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternField" text="IndexPatternField"/> | [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 131 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [es_agg_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [agg_field_types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/agg_field_types.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [percentile_agg_field.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.ts#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern), [es_geo_grid_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx#:~:text=IndexPattern)+ 98 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternsService" text="IndexPatternsService"/> | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - |
@ -703,12 +699,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=esFilters), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=esFilters) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType)+ 10 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IIndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_embeddable.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType), [options_list_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/controls/control_types/options_list/options_list_editor.tsx#:~:text=IFieldType) | 8.1 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | - |
@ -811,9 +801,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternsContract" text="IndexPatternsContract"/> | [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/target/types/public/management/roles/edit_role/edit_role_page.d.ts#:~:text=IndexPatternsContract), [edit_role_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/target/types/public/management/roles/edit_role/edit_role_page.d.ts#:~:text=IndexPatternsContract), [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx#:~:text=IndexPatternsContract), [edit_role_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/target/types/public/management/roles/edit_role/edit_role_page.d.ts#:~:text=IndexPatternsContract), [edit_role_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/target/types/public/management/roles/edit_role/edit_role_page.d.ts#:~:text=IndexPatternsContract) | - |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | - |
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | - |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesPluginSetup.spacesService" text="spacesService"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=spacesService), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=spacesService), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=spacesService), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=spacesService) | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.getSpaceId" text="getSpaceId"/> | [audit_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/audit/audit_service.ts#:~:text=getSpaceId), [check_privileges_dynamically.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/check_privileges_dynamically.ts#:~:text=getSpaceId), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=getSpaceId), [check_privileges_dynamically.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts#:~:text=getSpaceId) | 7.16 |
@ -844,9 +834,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/helpers.tsx#:~:text=Filter), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/helpers.tsx#:~:text=Filter)+ 165 more | 8.1 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 4 more | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 4 more | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesPluginSetup.spacesService" text="spacesService"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/plugin.ts#:~:text=spacesService), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=spacesService), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=spacesService) | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.getSpaceId" text="getSpaceId"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/plugin.ts#:~:text=getSpaceId), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=getSpaceId), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=getSpaceId) | 7.16 |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesPluginSetup.spacesService" text="spacesService"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=spacesService), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=spacesService), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/plugin.ts#:~:text=spacesService) | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.getSpaceId" text="getSpaceId"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=getSpaceId), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=getSpaceId), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/plugin.ts#:~:text=getSpaceId) | 7.16 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | - |
@ -1077,16 +1067,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-public.AggConfig.toJSON" text="toJSON"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=toJSON) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=esFilters), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=esFilters) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=esFilters), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=esFilters) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE" text="INDEX_PATTERN_SAVED_OBJECT_TYPE"/> | [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE)+ 8 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.AggConfig.toJSON" text="toJSON"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=toJSON) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern) | - |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern) | - |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=Filter) | 8.1 |

View file

@ -445,22 +445,14 @@
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.sort",
"type": "CompoundType",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"(string[][] & ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined"
"string[][] | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
@ -767,369 +759,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "LegacySavedSearch",
"description": [],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": true,
"references": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
"{ create: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; history: Record<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; removeField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; setFields: (newFields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; getId: () => string; getFields: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"; getField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; createCopy: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; createChild: (options?: {}) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; setParent: (parent?: Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceOptions",
"text": "SearchSourceOptions"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; getParent: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
" | undefined; fetch$: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => ",
"Observable",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<",
"SearchResponse",
"<any>>>; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => Promise<",
"SearchResponse",
"<any>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"; serialize: () => { searchSourceJSON: string; references: ",
"SavedObjectReference",
"[]; }; }"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOrder",
"[]"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.grid",
"type": "Object",
"tags": [],
"label": "grid",
"description": [],
"signature": [
"DiscoverGridSettings"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.save",
"type": "Function",
"tags": [],
"label": "save",
"description": [],
"signature": [
"(saveOptions: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
},
") => Promise<string>"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.save.$1",
"type": "Object",
"tags": [],
"label": "saveOptions",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
}
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.copyOnSave",
"type": "CompoundType",
"tags": [],
"label": "copyOnSave",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.LegacySavedSearch.hideChart",
"type": "CompoundType",
"tags": [],
"label": "hideChart",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch",
@ -1363,7 +992,8 @@
"label": "sort",
"description": [],
"signature": [
"[string, string][] | undefined"
"SortOrder",
"[] | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
@ -1430,94 +1060,37 @@
"label": "sharingSavedObjectProps",
"description": [],
"signature": [
"{ outcome?: \"conflict\" | \"exactMatch\" | \"aliasMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined"
"{ outcome?: \"conflict\" | \"aliasMatch\" | \"exactMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "SavedSearchLoader",
"description": [],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": true,
"references": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.LegacySavedSearch",
"text": "LegacySavedSearch"
},
">"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.get.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.urlFor",
"type": "Function",
"id": "def-public.SavedSearch.viewMode",
"type": "CompoundType",
"tags": [],
"label": "urlFor",
"label": "viewMode",
"description": [],
"signature": [
"(id: string) => string"
"VIEW_MODE",
" | undefined"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.urlFor.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/discover/public/saved_searches/legacy/types.ts",
"deprecated": false,
"isRequired": true
}
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.hideAggregatedPreview",
"type": "CompoundType",
"tags": [],
"label": "hideAggregatedPreview",
"description": [],
"signature": [
"boolean | undefined"
],
"returnComment": []
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -1706,69 +1279,7 @@
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "discover",
"id": "def-public.__LEGACY",
"type": "Object",
"tags": [
"deprecated"
],
"label": "__LEGACY",
"description": [],
"path": "src/plugins/discover/public/saved_searches/index.ts",
"deprecated": true,
"references": [
{
"plugin": "visualizations",
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts"
},
{
"plugin": "visualizations",
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts"
}
],
"children": [
{
"parentPluginId": "discover",
"id": "def-public.__LEGACY.createSavedSearchesLoader",
"type": "Function",
"tags": [],
"label": "createSavedSearchesLoader",
"description": [],
"signature": [
"({ savedObjectsClient, savedObjects }: Services) => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
],
"path": "src/plugins/discover/public/saved_searches/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-public.__LEGACY.createSavedSearchesLoader.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"Services"
],
"path": "src/plugins/discover/public/saved_searches/legacy/saved_searches.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup",
@ -1832,27 +1343,6 @@
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.__LEGACY",
"type": "Object",
"tags": [],
"label": "__LEGACY",
"description": [],
"signature": [
"{ savedSearchLoader: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
},
"; }"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.urlGenerator",
@ -1881,7 +1371,7 @@
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/scheduled_query_groups/scheduled_query_group_queries_status_table.tsx"
"path": "x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx"
},
{
"plugin": "osquery",
@ -2112,6 +1602,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_FIELD_STATISTICS",
"type": "string",
"tags": [],
"label": "SHOW_FIELD_STATISTICS",
"description": [],
"signature": [
"\"discover:showFieldStatistics\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_MULTIFIELDS",

View file

@ -18,7 +18,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 103 | 0 | 77 | 7 |
| 84 | 0 | 58 | 7 |
## Client
@ -28,9 +28,6 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
### Start
<DocDefinitionList data={[discoverObj.client.start]}/>
### Objects
<DocDefinitionList data={discoverObj.client.objects}/>
### Functions
<DocDefinitionList data={discoverObj.client.functions}/>

View file

@ -1276,7 +1276,7 @@
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>) => Promise<E | ",
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>) => Promise<",
{
"pluginId": "embeddable",
"scope": "public",
@ -1284,7 +1284,7 @@
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
">"
" | E>"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
@ -6150,7 +6150,7 @@
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined) => Promise<TEmbeddable | ",
"> | undefined) => Promise<",
{
"pluginId": "embeddable",
"scope": "public",
@ -6158,7 +6158,7 @@
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
">"
" | TEmbeddable>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false,
@ -6267,7 +6267,7 @@
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined) => Promise<TEmbeddable | ",
"> | undefined) => Promise<",
{
"pluginId": "embeddable",
"scope": "public",
@ -6275,7 +6275,7 @@
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
" | undefined>"
" | TEmbeddable | undefined>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false,
@ -8307,7 +8307,7 @@
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<I, O, E, T>, \"telemetry\" | \"inject\" | \"extract\" | \"migrations\" | \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
"<I, O, E, T>, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts",
"deprecated": false,

View file

@ -22,7 +22,7 @@
"label": "ConfigType",
"description": [],
"signature": [
"{ readonly host?: string | undefined; readonly enabled: boolean; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
"{ readonly host?: string | undefined; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
@ -53,15 +53,7 @@
"section": "def-server.Type",
"text": "Type"
},
"<string | undefined>; enabled: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<boolean>; accessCheckTimeout: ",
"<string | undefined>; accessCheckTimeout: ",
{
"pluginId": "@kbn/config-schema",
"scope": "server",

File diff suppressed because it is too large Load diff

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 |
|-------------------|-----------|------------------------|-----------------|
| 2086 | 27 | 1640 | 4 |
| 2092 | 27 | 1646 | 3 |
## Client

View file

@ -3860,65 +3860,6 @@
}
],
"returnComment": []
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.SourceFormat.htmlConvert",
"type": "Function",
"tags": [],
"label": "htmlConvert",
"description": [],
"signature": [
"(value: string, options?: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined) => string"
],
"path": "src/plugins/field_formats/common/converters/source.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "fieldFormats",
"id": "def-common.SourceFormat.htmlConvert.$1",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/field_formats/common/converters/source.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.SourceFormat.htmlConvert.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined"
],
"path": "src/plugins/field_formats/common/converters/source.tsx",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -4874,19 +4815,6 @@
"path": "src/plugins/field_formats/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.HtmlContextTypeOptions.indexPattern",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
"{ formatHit: (hit: { highlight: Record<string, string[]>; }) => Record<string, string>; } | undefined"
],
"path": "src/plugins/field_formats/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.HtmlContextTypeOptions.hit",

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 |
|-------------------|-----------|------------------------|-----------------|
| 288 | 7 | 250 | 3 |
| 284 | 7 | 246 | 3 |
## Client

View file

@ -233,7 +233,7 @@
{
"parentPluginId": "fleet",
"id": "def-public.CreatePackagePolicyRouteState.onSaveNavigateTo",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "onSaveNavigateTo",
"description": [
@ -248,23 +248,7 @@
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined] | ((newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
") => [appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined]) | undefined"
" | undefined] | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
"deprecated": false
@ -306,6 +290,21 @@
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-public.CreatePackagePolicyRouteState.onSaveQueryParams",
"type": "Object",
"tags": [],
"label": "onSaveQueryParams",
"description": [
"supported query params for onSaveNavigateTo path"
],
"signature": [
"{ showAddAgentHelp?: boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; } | undefined; openEnrollmentFlyout?: boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; } | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -507,6 +506,19 @@
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-public.NewPackagePolicy.elasticsearch",
"type": "Object",
"tags": [],
"label": "elasticsearch",
"description": [],
"signature": [
"{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -1145,6 +1157,19 @@
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-public.PackagePolicyEditExtension.useLatestPackageVersion",
"type": "CompoundType",
"tags": [],
"label": "useLatestPackageVersion",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-public.PackagePolicyEditExtension.Component",
@ -1340,7 +1365,7 @@
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined; }"
"> | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; }"
],
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
"deprecated": false
@ -1481,6 +1506,38 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-public.OnSaveQueryParamKeys",
"type": "Type",
"tags": [],
"label": "OnSaveQueryParamKeys",
"description": [
"\nSupported query parameters for CreatePackagePolicyRouteState"
],
"signature": [
"\"showAddAgentHelp\" | \"openEnrollmentFlyout\""
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-public.OnSaveQueryParamOpts",
"type": "Type",
"tags": [],
"label": "OnSaveQueryParamOpts",
"description": [
"\nQuery string parameter options for CreatePackagePolicyRouteState"
],
"signature": [
"boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; }"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-public.PackageAssetsComponent",
@ -4584,15 +4641,13 @@
"signature": [
"Pick<",
"KibanaClient",
", \"monitoring\" | \"security\" | \"create\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
" | undefined): ",
"TransportRequestPromise",
"<",
"ApiResponse",
"<Record<string, any>, unknown>>; }; }"
" | undefined): Promise<",
"TransportResult",
"<TResponse, unknown>>; }; }"
],
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
"deprecated": false
@ -4609,89 +4664,6 @@
}
]
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.authenticateAgentWithAccessToken",
"type": "Function",
"tags": [],
"label": "authenticateAgentWithAccessToken",
"description": [
"\nAuthenticate an agent with access toekn"
],
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
">"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.authenticateAgentWithAccessToken.$1",
"type": "CompoundType",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.authenticateAgentWithAccessToken.$2",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.getAgentStatusById",
@ -4876,15 +4848,13 @@
"signature": [
"Pick<",
"KibanaClient",
", \"monitoring\" | \"security\" | \"create\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
" | undefined): ",
"TransportRequestPromise",
"<",
"ApiResponse",
"<Record<string, any>, unknown>>; }; }"
" | undefined): Promise<",
"TransportResult",
"<TResponse, unknown>>; }; }"
],
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
"deprecated": false
@ -5487,6 +5457,75 @@
"deprecated": false
}
]
},
{
"parentPluginId": "fleet",
"id": "def-server.PackageService.ensureInstalledPackage",
"type": "Function",
"tags": [],
"label": "ensureInstalledPackage",
"description": [],
"signature": [
"(options: { savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
"; pkgVersion?: string | undefined; }) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installation",
"text": "Installation"
},
">"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.PackageService.ensureInstalledPackage.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
"; pkgVersion?: string | undefined; }"
],
"path": "x-pack/plugins/fleet/server/services/epm/packages/install.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
@ -6198,6 +6237,36 @@
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.LicenseService.hasAtLeast",
"type": "Function",
"tags": [],
"label": "hasAtLeast",
"description": [],
"signature": [
"(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined"
],
"path": "x-pack/plugins/fleet/common/services/license.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.LicenseService.hasAtLeast.$1",
"type": "CompoundType",
"tags": [],
"label": "licenseType",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
],
"path": "x-pack/plugins/fleet/common/services/license.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -9506,6 +9575,19 @@
],
"path": "x-pack/plugins/fleet/common/types/index.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FleetConfigType.developer",
"type": "Object",
"tags": [],
"label": "developer",
"description": [],
"signature": [
"{ disableRegistryVersionCheck?: boolean | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/common/types/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -11249,6 +11331,29 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.GetFullAgentConfigMapResponse",
"type": "Interface",
"tags": [],
"label": "GetFullAgentConfigMapResponse",
"description": [],
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.GetFullAgentConfigMapResponse.item",
"type": "string",
"tags": [],
"label": "item",
"description": [],
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.GetFullAgentPolicyRequest",
@ -13442,6 +13547,19 @@
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.NewPackagePolicy.elasticsearch",
"type": "Object",
"tags": [],
"label": "elasticsearch",
"description": [],
"signature": [
"{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -13681,7 +13799,7 @@
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", \"description\" | \"name\" | \"enabled\" | \"package\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\">"
", \"description\" | \"name\" | \"enabled\" | \"package\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\" | \"elasticsearch\">"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
@ -14870,7 +14988,7 @@
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", \"description\" | \"name\" | \"enabled\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\">> & { name: string; package: Partial<",
", \"description\" | \"name\" | \"enabled\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\" | \"elasticsearch\">> & { name: string; package: Partial<",
{
"pluginId": "fleet",
"scope": "common",
@ -17564,6 +17682,14 @@
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; ml_model: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; }"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
@ -17717,6 +17843,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_KUBERNETES_PACKAGE",
"type": "string",
"tags": [],
"label": "FLEET_KUBERNETES_PACKAGE",
"description": [],
"signature": [
"\"kubernetes\""
],
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX",
@ -18243,6 +18383,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.KUBERNETES_RUN_INSTRUCTIONS",
"type": "string",
"tags": [],
"label": "KUBERNETES_RUN_INSTRUCTIONS",
"description": [],
"signature": [
"\"kubectl apply -f elastic-agent-standalone-kubernetes.yaml\""
],
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG",
@ -18813,7 +18967,7 @@
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined; created_at: string; created_by: string; updated_by: string; revision: number; }"
"> | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; created_at: string; created_by: string; updated_by: string; revision: number; }"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
@ -19296,6 +19450,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.STANDALONE_RUN_INSTRUCTIONS",
"type": "string",
"tags": [],
"label": "STANDALONE_RUN_INSTRUCTIONS",
"description": [],
"signature": [
"\"./elastic-agent install\""
],
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.unremovablePackages",

View file

@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1210 | 15 | 1110 | 10 |
| 1223 | 15 | 1121 | 10 |
## Client

View file

@ -461,49 +461,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "home",
"id": "def-public.TutorialDirectoryNoticeComponent",
"type": "Type",
"tags": [],
"label": "TutorialDirectoryNoticeComponent",
"description": [],
"signature": [
"React.FunctionComponent<{}>"
],
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "home",
"id": "def-public.TutorialDirectoryNoticeComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
},
{
"parentPluginId": "home",
"id": "def-public.TutorialDirectoryNoticeComponent.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "home",
"id": "def-public.TutorialModuleNoticeComponent",
@ -555,7 +512,7 @@
"label": "TutorialSetup",
"description": [],
"signature": [
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
],
"path": "src/plugins/home/public/plugin.ts",
"deprecated": false,
@ -789,7 +746,7 @@
"label": "tutorials",
"description": [],
"signature": [
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
],
"path": "src/plugins/home/public/plugin.ts",
"deprecated": false

View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 99 | 3 | 77 | 5 |
| 96 | 2 | 74 | 5 |
## Client

View file

@ -641,7 +641,7 @@
"label": "IndexManagementConfig",
"description": [],
"signature": [
"{ readonly enabled: boolean; }"
"{ readonly ui: Readonly<{} & { enabled: boolean; }>; }"
],
"path": "x-pack/plugins/index_management/server/config.ts",
"deprecated": false,
@ -2324,7 +2324,7 @@
"label": "MAJOR_VERSION",
"description": [],
"signature": [
"\"8.0.0\""
"\"8.1.0\""
],
"path": "x-pack/plugins/index_management/common/constants/plugin.ts",
"deprecated": false,

View file

@ -165,42 +165,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "interactiveSetup",
"id": "def-common.InteractiveSetupViewState",
"type": "Interface",
"tags": [],
"label": "InteractiveSetupViewState",
"description": [
"\nA set of state details that interactive setup view retrieves from the Kibana server."
],
"path": "src/plugins/interactive_setup/common/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "interactiveSetup",
"id": "def-common.InteractiveSetupViewState.elasticsearchConnectionStatus",
"type": "Enum",
"tags": [],
"label": "elasticsearchConnectionStatus",
"description": [
"\nCurrent status of the Elasticsearch connection."
],
"signature": [
{
"pluginId": "interactiveSetup",
"scope": "common",
"docId": "kibInteractiveSetupPluginApi",
"section": "def-common.ElasticsearchConnectionStatus",
"text": "ElasticsearchConnectionStatus"
}
],
"path": "src/plugins/interactive_setup/common/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "interactiveSetup",
"id": "def-common.PingResult",
@ -247,6 +211,52 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "interactiveSetup",
"id": "def-common.StatusResult",
"type": "Interface",
"tags": [],
"label": "StatusResult",
"description": [],
"path": "src/plugins/interactive_setup/common/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "interactiveSetup",
"id": "def-common.StatusResult.connectionStatus",
"type": "Enum",
"tags": [],
"label": "connectionStatus",
"description": [
"\nFull certificate chain of cluster at requested address. Only present if cluster uses HTTPS."
],
"signature": [
{
"pluginId": "interactiveSetup",
"scope": "common",
"docId": "kibInteractiveSetupPluginApi",
"section": "def-common.ElasticsearchConnectionStatus",
"text": "ElasticsearchConnectionStatus"
}
],
"path": "src/plugins/interactive_setup/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "interactiveSetup",
"id": "def-common.StatusResult.isSetupOnHold",
"type": "boolean",
"tags": [],
"label": "isSetupOnHold",
"description": [
"\nIndicates whether Kibana is currently on hold and cannot proceed to `setup` yet."
],
"path": "src/plugins/interactive_setup/common/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [

View file

@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 26 | 0 | 16 | 0 |
| 27 | 0 | 17 | 0 |
## Common

View file

@ -1185,7 +1185,7 @@
"label": "level",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
"\"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts",
"deprecated": false,
@ -1278,7 +1278,7 @@
"label": "level",
"description": [],
"signature": [
"{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
"{ name: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { info: boolean; error: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
@ -2695,7 +2695,7 @@
"label": "parseLogLevel",
"description": [],
"signature": [
"(name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
"(name: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { info: boolean; error: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
@ -2708,7 +2708,7 @@
"label": "name",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
"\"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
@ -2726,7 +2726,7 @@
"label": "pickLevelFromFlags",
"description": [],
"signature": [
"(flags: Record<string, string | boolean | string[] | undefined>, options: { default?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
"(flags: Record<string, string | boolean | string[] | undefined>, options: { default?: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
@ -2763,7 +2763,7 @@
"label": "default",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined"
"\"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false
@ -3821,7 +3821,7 @@
"level/type of message"
],
"signature": [
"\"write\" | \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"verbose\""
"\"write\" | \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/message.ts",
"deprecated": false
@ -4079,7 +4079,7 @@
"label": "log",
"description": [],
"signature": [
"{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
"{ defaultLevel?: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run.ts",
"deprecated": false
@ -4135,7 +4135,7 @@
"label": "log",
"description": [],
"signature": [
"{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
"{ defaultLevel?: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined"
],
"path": "packages/kbn-dev-utils/src/run/run_with_commands.ts",
"deprecated": false
@ -4368,7 +4368,7 @@
"\nLog level, messages below this level will be ignored"
],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
"\"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts",
"deprecated": false
@ -4684,7 +4684,7 @@
"label": "LogLevel",
"description": [],
"signature": [
"\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
"\"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\""
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,
@ -4698,7 +4698,7 @@
"label": "ParsedLogLevel",
"description": [],
"signature": [
"{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
"{ name: \"info\" | \"error\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { info: boolean; error: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }"
],
"path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts",
"deprecated": false,

View file

@ -2812,7 +2812,7 @@
"section": "def-common.Filter",
"text": "Filter"
},
") => { meta: { disabled: boolean; alias?: string | null | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ",
") => { meta: { disabled: boolean; alias?: string | null | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
@ -2869,7 +2869,7 @@
"section": "def-common.Filter",
"text": "Filter"
},
") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ",
") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
@ -3240,9 +3240,6 @@
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-es-query/src/es_query/types.ts",
"deprecated": false
}
@ -3920,7 +3917,7 @@
"label": "FilterMeta",
"description": [],
"signature": [
"{ alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
"{ alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
],
"path": "packages/kbn-es-query/src/filters/build_filters/types.ts",
"deprecated": false,
@ -4032,11 +4029,11 @@
},
" & { meta: ",
"PhraseFilterMeta",
"; query: { match_phrase?: Record<string, string | ",
"; query: { match_phrase?: Partial<Record<string, string | ",
"QueryDslMatchPhraseQuery",
"> | undefined; match?: Record<string, string | number | boolean | ",
">> | undefined; match?: Partial<Record<string, string | number | boolean | ",
"QueryDslMatchQuery",
"> | undefined; }; }"
">> | undefined; }; }"
],
"path": "packages/kbn-es-query/src/filters/build_filters/phrase_filter.ts",
"deprecated": false,

View file

@ -658,7 +658,7 @@
"label": "EcsEventType",
"description": [],
"signature": [
"\"start\" | \"end\" | \"user\" | \"error\" | \"info\" | \"connection\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\""
"\"start\" | \"end\" | \"user\" | \"info\" | \"group\" | \"error\" | \"connection\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\""
],
"path": "packages/kbn-logging/src/ecs/event.ts",
"deprecated": false,

View file

@ -595,6 +595,22 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/optimizer",
"id": "def-server.runFindBabelHelpersInEntryBundlesCli",
"type": "Function",
"tags": [],
"label": "runFindBabelHelpersInEntryBundlesCli",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "packages/kbn-optimizer/src/babel_runtime_helpers/find_babel_runtime_helpers_in_entry_bundles.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/optimizer",
"id": "def-server.runKbnOptimizerCli",

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 44 | 0 | 44 | 9 |
| 45 | 0 | 45 | 9 |
## Server

View file

@ -943,6 +943,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/rule-data-utils",
"id": "def-server.EVENT_MODULE",
"type": "string",
"tags": [],
"label": "EVENT_MODULE",
"description": [],
"signature": [
"\"event.module\""
],
"path": "packages/kbn-rule-data-utils/src/technical_field_names.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/rule-data-utils",
"id": "def-server.KIBANA_NAMESPACE",
@ -1007,7 +1021,7 @@
"label": "TechnicalRuleDataFieldName",
"description": [],
"signature": [
"\"tags\" | \"kibana\" | \"@timestamp\" | \"event.kind\" | \"kibana.consumers\" | \"ecs.version\" | \"event.action\" | \"kibana.alert.action_group\" | \"kibana.alert.duration.us\" | \"kibana.alert.end\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.instance.id\" | \"kibana.alert.rule.consumer\" | \"kibana.alert.rule.producer\" | \"kibana.alert.reason\" | \"kibana.alert.risk_score\" | \"kibana.alert.rule.author\" | \"kibana.alert.rule.created_at\" | \"kibana.alert.rule.created_by\" | \"kibana.alert.rule.description\" | \"kibana.alert.rule.enabled\" | \"kibana.alert.rule.from\" | \"kibana.alert.rule.interval\" | \"kibana.alert.rule.license\" | \"kibana.alert.rule.name\" | \"kibana.alert.rule.note\" | \"kibana.alert.rule.params\" | \"kibana.alert.rule.references\" | \"kibana.alert.rule.risk_score\" | \"kibana.alert.rule.risk_score_mapping\" | \"kibana.alert.rule.rule_id\" | \"kibana.alert.rule.rule_name_override\" | \"kibana.alert.rule.severity\" | \"kibana.alert.rule.severity_mapping\" | \"kibana.alert.rule.tags\" | \"kibana.alert.rule.to\" | \"kibana.alert.rule.type\" | \"kibana.alert.rule.rule_type_id\" | \"kibana.alert.rule.updated_at\" | \"kibana.alert.rule.updated_by\" | \"kibana.alert.rule.version\" | \"kibana.alert.start\" | \"kibana.alert.severity\" | \"kibana.alert.status\" | \"kibana.alert.system_status\" | \"kibana.alert.uuid\" | \"kibana.alert.workflow_reason\" | \"kibana.alert.workflow_status\" | \"kibana.alert.workflow_user\" | \"kibana.alert.rule.uuid\" | \"kibana.alert.rule.category\" | \"kibana.space_ids\" | \"kibana.version\" | \"kibana.alert\" | \"kibana.alert.rule\""
"\"tags\" | \"kibana\" | \"@timestamp\" | \"event.kind\" | \"kibana.consumers\" | \"ecs.version\" | \"event.action\" | \"event.module\" | \"kibana.alert.action_group\" | \"kibana.alert.duration.us\" | \"kibana.alert.end\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.instance.id\" | \"kibana.alert.rule.consumer\" | \"kibana.alert.rule.producer\" | \"kibana.alert.reason\" | \"kibana.alert.risk_score\" | \"kibana.alert.rule.author\" | \"kibana.alert.rule.created_at\" | \"kibana.alert.rule.created_by\" | \"kibana.alert.rule.description\" | \"kibana.alert.rule.enabled\" | \"kibana.alert.rule.from\" | \"kibana.alert.rule.interval\" | \"kibana.alert.rule.license\" | \"kibana.alert.rule.name\" | \"kibana.alert.rule.note\" | \"kibana.alert.rule.params\" | \"kibana.alert.rule.references\" | \"kibana.alert.rule.risk_score\" | \"kibana.alert.rule.risk_score_mapping\" | \"kibana.alert.rule.rule_id\" | \"kibana.alert.rule.rule_name_override\" | \"kibana.alert.rule.severity\" | \"kibana.alert.rule.severity_mapping\" | \"kibana.alert.rule.tags\" | \"kibana.alert.rule.to\" | \"kibana.alert.rule.type\" | \"kibana.alert.rule.rule_type_id\" | \"kibana.alert.rule.updated_at\" | \"kibana.alert.rule.updated_by\" | \"kibana.alert.rule.version\" | \"kibana.alert.start\" | \"kibana.alert.severity\" | \"kibana.alert.status\" | \"kibana.alert.system_status\" | \"kibana.alert.uuid\" | \"kibana.alert.workflow_reason\" | \"kibana.alert.workflow_status\" | \"kibana.alert.workflow_user\" | \"kibana.alert.rule.uuid\" | \"kibana.alert.rule.category\" | \"kibana.space_ids\" | \"kibana.version\" | \"kibana.alert\" | \"kibana.alert.rule\""
],
"path": "packages/kbn-rule-data-utils/src/technical_field_names.ts",
"deprecated": false,

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 74 | 0 | 71 | 0 |
| 75 | 0 | 72 | 0 |
## Server

File diff suppressed because it is too large Load diff

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 54 | 0 | 51 | 0 |
| 57 | 0 | 51 | 0 |
## Server

View file

@ -426,7 +426,7 @@
"label": "Severity",
"description": [],
"signature": [
"\"high\" | \"low\" | \"critical\" | \"medium\""
"\"high\" | \"low\" | \"medium\" | \"critical\""
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/severity/index.ts",
"deprecated": false,
@ -440,7 +440,7 @@
"label": "SeverityMapping",
"description": [],
"signature": [
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"critical\" | \"medium\"; }[]"
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"medium\" | \"critical\"; }[]"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/severity_mapping/index.ts",
"deprecated": false,
@ -454,7 +454,7 @@
"label": "SeverityMappingItem",
"description": [],
"signature": [
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"critical\" | \"medium\"; }"
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"medium\" | \"critical\"; }"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/severity_mapping/index.ts",
"deprecated": false,
@ -468,7 +468,7 @@
"label": "SeverityMappingOrUndefined",
"description": [],
"signature": [
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"critical\" | \"medium\"; }[] | undefined"
"{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"medium\" | \"critical\"; }[] | undefined"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/severity_mapping/index.ts",
"deprecated": false,
@ -482,7 +482,7 @@
"label": "SeverityOrUndefined",
"description": [],
"signature": [
"\"high\" | \"low\" | \"critical\" | \"medium\" | undefined"
"\"high\" | \"low\" | \"medium\" | \"critical\" | undefined"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/severity/index.ts",
"deprecated": false,
@ -818,7 +818,7 @@
"label": "Type",
"description": [],
"signature": [
"\"query\" | \"eql\" | \"threshold\" | \"threat_match\" | \"machine_learning\" | \"saved_query\""
"\"query\" | \"eql\" | \"threat_match\" | \"threshold\" | \"machine_learning\" | \"saved_query\""
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/type/index.ts",
"deprecated": false,
@ -832,7 +832,7 @@
"label": "TypeOrUndefined",
"description": [],
"signature": [
"\"query\" | \"eql\" | \"threshold\" | \"threat_match\" | \"machine_learning\" | \"saved_query\" | undefined"
"\"query\" | \"eql\" | \"threat_match\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | undefined"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/type/index.ts",
"deprecated": false,
@ -1256,7 +1256,7 @@
],
"signature": [
"Type",
"<{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"critical\" | \"medium\"; }[], { field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"critical\" | \"medium\"; }[] | undefined, unknown>"
"<{ field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"medium\" | \"critical\"; }[], { field: string; operator: \"equals\"; value: string; severity: \"high\" | \"low\" | \"medium\" | \"critical\"; }[] | undefined, unknown>"
],
"path": "packages/kbn-securitysolution-io-ts-alerting-types/src/default_severity_mapping_array/index.ts",
"deprecated": false,

View file

@ -1642,6 +1642,16 @@
"description": [],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-io-ts-list-types",
"id": "def-common.UseExceptionListsProps.showHostIsolationExceptions",
"type": "boolean",
"tags": [],
"label": "showHostIsolationExceptions",
"description": [],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts",
"deprecated": false
}
],
"initialIsOpen": false

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 418 | 1 | 409 | 0 |
| 419 | 1 | 410 | 0 |
## Common

View file

@ -78,7 +78,7 @@
"label": "ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_DESCRIPTION",
"description": [],
"signature": [
"\"Endpoint Security Host Isolation Exceptions List\""
"\"Endpoint Security Host isolation exceptions List\""
],
"path": "packages/kbn-securitysolution-list-constants/src/index.ts",
"deprecated": false,
@ -106,7 +106,7 @@
"label": "ENDPOINT_HOST_ISOLATION_EXCEPTIONS_LIST_NAME",
"description": [],
"signature": [
"\"Endpoint Security Host Isolation Exceptions List\""
"\"Endpoint Security Host isolation exceptions List\""
],
"path": "packages/kbn-securitysolution-list-constants/src/index.ts",
"deprecated": false,

View file

@ -401,7 +401,7 @@
"\nHook for fetching ExceptionLists\n"
],
"signature": [
"({ errorMessage, http, initialPagination, filterOptions, namespaceTypes, notifications, showTrustedApps, showEventFilters, }: ",
"({ errorMessage, http, initialPagination, filterOptions, namespaceTypes, notifications, showTrustedApps, showEventFilters, showHostIsolationExceptions, }: ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
@ -426,7 +426,7 @@
"id": "def-common.useExceptionLists.$1",
"type": "Object",
"tags": [],
"label": "{\n errorMessage,\n http,\n initialPagination = DEFAULT_PAGINATION,\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n showEventFilters = false,\n}",
"label": "{\n errorMessage,\n http,\n initialPagination = DEFAULT_PAGINATION,\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n showEventFilters = false,\n showHostIsolationExceptions = false,\n}",
"description": [],
"signature": [
{

View file

@ -1722,7 +1722,7 @@
"label": "getFilters",
"description": [],
"signature": [
"({ filters, namespaceTypes, showTrustedApps, showEventFilters, }: ",
"({ filters, namespaceTypes, showTrustedApps, showEventFilters, showHostIsolationExceptions, }: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
@ -1740,7 +1740,7 @@
"id": "def-common.getFilters.$1",
"type": "Object",
"tags": [],
"label": "{\n filters,\n namespaceTypes,\n showTrustedApps,\n showEventFilters,\n}",
"label": "{\n filters,\n namespaceTypes,\n showTrustedApps,\n showEventFilters,\n showHostIsolationExceptions,\n}",
"description": [],
"signature": [
{
@ -3243,6 +3243,16 @@
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.GetFiltersParams.showHostIsolationExceptions",
"type": "boolean",
"tags": [],
"label": "showHostIsolationExceptions",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false
}
],
"initialIsOpen": false

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 222 | 0 | 177 | 0 |
| 223 | 0 | 178 | 0 |
## Common

View file

@ -0,0 +1,365 @@
{
"id": "@kbn/securitysolution-rules",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.flattenWithPrefix",
"type": "Function",
"tags": [],
"label": "flattenWithPrefix",
"description": [],
"signature": [
"(prefix: string, maybeObj: unknown) => Record<string, SearchTypes>"
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.flattenWithPrefix.$1",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.flattenWithPrefix.$2",
"type": "Unknown",
"tags": [],
"label": "maybeObj",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.isRuleType",
"type": "Function",
"tags": [],
"label": "isRuleType",
"description": [],
"signature": [
"(ruleType: unknown) => ruleType is \"query\" | \"eql\" | \"threat_match\" | \"threshold\" | \"machine_learning\" | \"saved_query\""
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.isRuleType.$1",
"type": "Unknown",
"tags": [],
"label": "ruleType",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.isRuleTypeId",
"type": "Function",
"tags": [],
"label": "isRuleTypeId",
"description": [],
"signature": [
"(ruleTypeId: unknown) => ruleTypeId is ",
{
"pluginId": "@kbn/securitysolution-rules",
"scope": "server",
"docId": "kibKbnSecuritysolutionRulesPluginApi",
"section": "def-server.RuleTypeId",
"text": "RuleTypeId"
}
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.isRuleTypeId.$1",
"type": "Unknown",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-securitysolution-rules/src/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.EQL_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "EQL_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.eqlRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.INDICATOR_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "INDICATOR_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.indicatorRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ML_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "ML_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.mlRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.QUERY_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "QUERY_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.queryRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.RuleType",
"type": "Type",
"tags": [],
"label": "RuleType",
"description": [],
"signature": [
"\"query\" | \"eql\" | \"threat_match\" | \"threshold\" | \"machine_learning\" | \"saved_query\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.RuleTypeId",
"type": "Type",
"tags": [],
"label": "RuleTypeId",
"description": [],
"signature": [
"\"siem.eqlRule\" | \"siem.indicatorRule\" | \"siem.mlRule\" | \"siem.queryRule\" | \"siem.savedQueryRule\" | \"siem.thresholdRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.SAVED_QUERY_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "SAVED_QUERY_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.savedQueryRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.SIGNALS_ID",
"type": "string",
"tags": [],
"label": "SIGNALS_ID",
"description": [
"\nId for the legacy siem signals alerting type"
],
"signature": [
"\"siem.signals\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.THRESHOLD_RULE_TYPE_ID",
"type": "string",
"tags": [],
"label": "THRESHOLD_RULE_TYPE_ID",
"description": [],
"signature": [
"\"siem.thresholdRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings",
"type": "Object",
"tags": [],
"label": "ruleTypeMappings",
"description": [
"\nMaps legacy rule types to RAC rule type IDs."
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.eql",
"type": "string",
"tags": [],
"label": "eql",
"description": [],
"signature": [
"\"siem.eqlRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.machine_learning",
"type": "string",
"tags": [],
"label": "machine_learning",
"description": [],
"signature": [
"\"siem.mlRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"\"siem.queryRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.saved_query",
"type": "string",
"tags": [],
"label": "saved_query",
"description": [],
"signature": [
"\"siem.savedQueryRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.threat_match",
"type": "string",
"tags": [],
"label": "threat_match",
"description": [],
"signature": [
"\"siem.indicatorRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-rules",
"id": "def-server.ruleTypeMappings.threshold",
"type": "string",
"tags": [],
"label": "threshold",
"description": [],
"signature": [
"\"siem.thresholdRule\""
],
"path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

View file

@ -0,0 +1,33 @@
---
id: kibKbnSecuritysolutionRulesPluginApi
slug: /kibana-dev-docs/api/kbn-securitysolution-rules
title: "@kbn/securitysolution-rules"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the @kbn/securitysolution-rules plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules']
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 kbnSecuritysolutionRulesObj from './kbn_securitysolution_rules.json';
security solution rule utilities to use across plugins
Contact [Owner missing] for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 23 | 0 | 21 | 0 |
## Server
### Objects
<DocDefinitionList data={kbnSecuritysolutionRulesObj.server.objects}/>
### Functions
<DocDefinitionList data={kbnSecuritysolutionRulesObj.server.functions}/>
### Consts, variables and types
<DocDefinitionList data={kbnSecuritysolutionRulesObj.server.misc}/>

View file

@ -1175,6 +1175,40 @@
}
],
"functions": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.convertToKibanaClient",
"type": "Function",
"tags": [],
"label": "convertToKibanaClient",
"description": [],
"signature": [
"(esClient: ",
"default",
") => ",
"KibanaClient"
],
"path": "packages/kbn-test/src/es/client_to_kibana_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/test",
"id": "def-server.convertToKibanaClient.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"default"
],
"path": "packages/kbn-test/src/es/client_to_kibana_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.createTestEsCluster",
@ -2870,6 +2904,22 @@
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"() => ",
"default"
],
"path": "packages/kbn-test/src/es/test_es_cluster.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/test",
"id": "def-server.ICluster.getKibanaEsClient",
"type": "Function",
"tags": [],
"label": "getKibanaEsClient",
"description": [],
"signature": [
"() => ",
"KibanaClient"

View file

@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 200 | 5 | 177 | 9 |
| 203 | 5 | 180 | 9 |
## Server

View file

@ -106,259 +106,6 @@
}
],
"functions": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.$setupXsrfRequestInterceptor",
"type": "Function",
"tags": [],
"label": "$setupXsrfRequestInterceptor",
"description": [],
"signature": [
"(version: string) => ($httpProvider: angular.IHttpProvider) => void"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.$setupXsrfRequestInterceptor.$1",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule",
"type": "Function",
"tags": [],
"label": "configureAppAngularModule",
"description": [],
"signature": [
"(angularModule: angular.IModule, newPlatform: { core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
"; readonly env: { mode: Readonly<",
{
"pluginId": "@kbn/config",
"scope": "server",
"docId": "kibKbnConfigPluginApi",
"section": "def-server.EnvironmentMode",
"text": "EnvironmentMode"
},
">; packageInfo: Readonly<",
{
"pluginId": "@kbn/config",
"scope": "server",
"docId": "kibKbnConfigPluginApi",
"section": "def-server.PackageInfo",
"text": "PackageInfo"
},
">; }; }, isLocalAngular: boolean, getHistory?: (() => ",
"History",
"<any>) | undefined) => void"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$1",
"type": "Object",
"tags": [],
"label": "angularModule",
"description": [],
"signature": [
"angular.IModule"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$2",
"type": "Object",
"tags": [],
"label": "newPlatform",
"description": [],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$2.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$2.env",
"type": "Object",
"tags": [],
"label": "env",
"description": [],
"signature": [
"{ mode: Readonly<",
{
"pluginId": "@kbn/config",
"scope": "server",
"docId": "kibKbnConfigPluginApi",
"section": "def-server.EnvironmentMode",
"text": "EnvironmentMode"
},
">; packageInfo: Readonly<",
{
"pluginId": "@kbn/config",
"scope": "server",
"docId": "kibKbnConfigPluginApi",
"section": "def-server.PackageInfo",
"text": "PackageInfo"
},
">; }"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
}
]
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$3",
"type": "boolean",
"tags": [],
"label": "isLocalAngular",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule.$4",
"type": "Function",
"tags": [],
"label": "getHistory",
"description": [],
"signature": [
"(() => ",
"History",
"<any>) | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.createTopNavHelper",
"type": "Function",
"tags": [],
"label": "createTopNavHelper",
"description": [],
"signature": [
"(options: unknown) => angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
],
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.createTopNavHelper.$1",
"type": "Unknown",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.formatAngularHttpError",
"type": "Function",
"tags": [],
"label": "formatAngularHttpError",
"description": [],
"signature": [
"(error: ",
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.AngularHttpError",
"text": "AngularHttpError"
},
") => string"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.formatAngularHttpError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.AngularHttpError",
"text": "AngularHttpError"
}
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.formatESMsg",
@ -440,343 +187,11 @@
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.isAngularHttpError",
"type": "Function",
"tags": [],
"label": "isAngularHttpError",
"description": [],
"signature": [
"(error: any) => boolean"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.isAngularHttpError.$1",
"type": "Any",
"tags": [],
"label": "error",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.loadKbnTopNavDirectives",
"type": "Function",
"tags": [],
"label": "loadKbnTopNavDirectives",
"description": [],
"signature": [
"(navUi: unknown) => void"
],
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.loadKbnTopNavDirectives.$1",
"type": "Unknown",
"tags": [],
"label": "navUi",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PrivateProvider",
"type": "Function",
"tags": [],
"label": "PrivateProvider",
"description": [],
"signature": [
"() => angular.IServiceProvider"
],
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration",
"type": "Interface",
"tags": [],
"label": "RouteConfiguration",
"description": [],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.controller",
"type": "CompoundType",
"tags": [],
"label": "controller",
"description": [],
"signature": [
"string | ((...args: any[]) => void) | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.redirectTo",
"type": "string",
"tags": [],
"label": "redirectTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.resolveRedirectTo",
"type": "Function",
"tags": [],
"label": "resolveRedirectTo",
"description": [],
"signature": [
"((...args: any[]) => void) | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.resolveRedirectTo.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.reloadOnSearch",
"type": "CompoundType",
"tags": [],
"label": "reloadOnSearch",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.reloadOnUrl",
"type": "CompoundType",
"tags": [],
"label": "reloadOnUrl",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.outerAngularWrapperRoute",
"type": "CompoundType",
"tags": [],
"label": "outerAngularWrapperRoute",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.resolve",
"type": "Uncategorized",
"tags": [],
"label": "resolve",
"description": [],
"signature": [
"object | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.template",
"type": "string",
"tags": [],
"label": "template",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.k7Breadcrumbs",
"type": "Function",
"tags": [],
"label": "k7Breadcrumbs",
"description": [],
"signature": [
"((...args: any[]) => ",
"EuiBreadcrumb",
"[]) | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.k7Breadcrumbs.$1",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any[]"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.RouteConfiguration.requireUICapability",
"type": "string",
"tags": [],
"label": "requireUICapability",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.AngularHttpError",
"type": "Type",
"tags": [],
"label": "AngularHttpError",
"description": [],
"signature": [
"angular.IHttpResponse<{ message: string; }>"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.createTopNavDirective",
"type": "CompoundType",
"tags": [],
"label": "createTopNavDirective",
"description": [],
"signature": [
"angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController> | (string | angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>)[]"
],
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.IPrivate",
"type": "Type",
"tags": [],
"label": "IPrivate",
"description": [],
"signature": [
"<T>(provider: (...injectable: any[]) => T) => T"
],
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.IPrivate.$1",
"type": "Function",
"tags": [],
"label": "provider",
"description": [],
"signature": [
"(...injectable: any[]) => T"
],
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.IPrivate.$1.$1",
"type": "Array",
"tags": [],
"label": "injectable",
"description": [],
"signature": [
"any[]"
],
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.KibanaLegacySetup",

View file

@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 48 | 1 | 45 | 0 |
| 12 | 0 | 9 | 0 |
## Client
@ -28,9 +28,6 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
### Classes
<DocDefinitionList data={kibanaLegacyObj.client.classes}/>
### Interfaces
<DocDefinitionList data={kibanaLegacyObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={kibanaLegacyObj.client.misc}/>

File diff suppressed because one or more lines are too long

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 |
|-------------------|-----------|------------------------|-----------------|
| 297 | 8 | 260 | 5 |
| 282 | 2 | 245 | 5 |
## Client

View file

@ -57,6 +57,82 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-public.CharacterNotAllowedInField",
"type": "Class",
"tags": [],
"label": "CharacterNotAllowedInField",
"description": [
"\nwhen a user is attempting to create a field with disallowed character in the name, like *"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CharacterNotAllowedInField",
"text": "CharacterNotAllowedInField"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaUtils",
"id": "def-public.CharacterNotAllowedInField.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaUtils",
"id": "def-public.CharacterNotAllowedInField.Unnamed.$1",
"type": "string",
"tags": [],
"label": "character",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaUtils",
"id": "def-public.CharacterNotAllowedInField.Unnamed.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-public.Defer",
@ -1628,7 +1704,7 @@
"\nCreates {@link IKbnUrlStateStorage} state storage"
],
"signature": [
"({ useHash, history, onGetError, onSetError, }?: { useHash: boolean; history?: ",
"({ useHash, useHashQuery, history, onGetError, onSetError, }?: { useHash: boolean; useHashQuery?: boolean | undefined; history?: ",
"History",
"<any> | undefined; onGetError?: ((error: Error) => void) | undefined; onSetError?: ((error: Error) => void) | undefined; }) => ",
{
@ -1647,7 +1723,7 @@
"id": "def-public.createKbnUrlStateStorage.$1",
"type": "Object",
"tags": [],
"label": "{\n useHash = false,\n history,\n onGetError,\n onSetError,\n }",
"label": "{\n useHash = false,\n useHashQuery = true,\n history,\n onGetError,\n onSetError,\n }",
"description": [],
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"deprecated": false,
@ -1662,6 +1738,19 @@
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"deprecated": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-public.createKbnUrlStateStorage.$1.useHashQuery",
"type": "CompoundType",
"tags": [],
"label": "useHashQuery",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts",
"deprecated": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-public.createKbnUrlStateStorage.$1.history",
@ -2259,7 +2348,7 @@
"tags": [],
"label": "createSessionStorageStateStorage",
"description": [
"\nCreates {@link ISessionStorageStateStorage}\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
"\nCreates {@link ISessionStorageStateStorage}\n{@link https://github.com/elastic/kibana/blob/main/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
],
"signature": [
"(storage?: Storage) => ",
@ -2579,7 +2668,7 @@
"tags": [],
"label": "createStateContainerReactHelpers",
"description": [
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/main/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
],
"signature": [
"<Container extends ",
@ -3932,7 +4021,7 @@
"tags": [],
"label": "syncState",
"description": [
"\nUtility for syncing application state wrapped in state container\nwith some kind of storage (e.g. URL)\n\nGo {@link https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync | here} for a complete guide and examples.\n"
"\nUtility for syncing application state wrapped in state container\nwith some kind of storage (e.g. URL)\n\nGo {@link https://github.com/elastic/kibana/tree/main/src/plugins/kibana_utils/docs/state_sync | here} for a complete guide and examples.\n"
],
"signature": [
"({\n storageKey,\n stateStorage,\n stateContainer,\n}: ",
@ -4704,7 +4793,7 @@
"tags": [],
"label": "IKbnUrlStateStorage",
"description": [
"\nKbnUrlStateStorage is a state storage for {@link syncState} utility which:\n\n1. Keeps state in sync with the URL.\n2. Serializes data and stores it in the URL in one of the supported formats:\n * Rison encoded.\n * Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See Kibana's `state:storeInSessionStorage` advanced option for more context.\n3. Takes care of listening to the URL updates and notifies state about the updates.\n4. Takes care of batching URL updates to prevent redundant browser history records.\n\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md | Refer to this guide for more info}"
"\nKbnUrlStateStorage is a state storage for {@link syncState} utility which:\n\n1. Keeps state in sync with the URL.\n2. Serializes data and stores it in the URL in one of the supported formats:\n * Rison encoded.\n * Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See Kibana's `state:storeInSessionStorage` advanced option for more context.\n3. Takes care of listening to the URL updates and notifies state about the updates.\n4. Takes care of batching URL updates to prevent redundant browser history records.\n\n{@link https://github.com/elastic/kibana/blob/main/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md | Refer to this guide for more info}"
],
"signature": [
{
@ -4953,7 +5042,7 @@
"tags": [],
"label": "ISessionStorageStateStorage",
"description": [
"\n{@link IStateStorage} for storing state in browser {@link Storage}\n{@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
"\n{@link IStateStorage} for storing state in browser {@link Storage}\n{@link https://github.com/elastic/kibana/blob/main/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md | guide}"
],
"signature": [
{
@ -8115,6 +8204,82 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.CharacterNotAllowedInField",
"type": "Class",
"tags": [],
"label": "CharacterNotAllowedInField",
"description": [
"\nwhen a user is attempting to create a field with disallowed character in the name, like *"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.CharacterNotAllowedInField",
"text": "CharacterNotAllowedInField"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KbnError",
"text": "KbnError"
}
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaUtils",
"id": "def-common.CharacterNotAllowedInField.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaUtils",
"id": "def-common.CharacterNotAllowedInField.Unnamed.$1",
"type": "string",
"tags": [],
"label": "character",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.CharacterNotAllowedInField.Unnamed.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/kibana_utils/common/errors/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.Defer",
@ -8982,7 +9147,7 @@
"tags": [],
"label": "createStateContainerReactHelpers",
"description": [
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
"\nCreates helpers for using {@link StateContainer | State Containers} with react\nRefer to {@link https://github.com/elastic/kibana/blob/main/src/plugins/kibana_utils/docs/state_containers/react.md | guide} for details"
],
"signature": [
"<Container extends ",
@ -9346,8 +9511,8 @@
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"section": "def-server.Serializable",
"text": "Serializable"
},
">) => S"
],
@ -9394,8 +9559,8 @@
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"section": "def-server.Serializable",
"text": "Serializable"
},
">"
],
@ -10203,8 +10368,8 @@
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"section": "def-server.Serializable",
"text": "Serializable"
},
">) => P) | undefined"
],
@ -10233,8 +10398,8 @@
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
"section": "def-server.Serializable",
"text": "Serializable"
},
">"
],

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 |
|-------------------|-----------|------------------------|-----------------|
| 606 | 3 | 413 | 8 |
| 615 | 3 | 420 | 8 |
## Client

View file

@ -134,7 +134,7 @@
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
"\"data\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"deprecated": false
@ -874,7 +874,7 @@
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
"\"data\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/expressions/metric_chart/types.ts",
"deprecated": false
@ -1179,7 +1179,7 @@
"label": "legendDisplay",
"description": [],
"signature": [
"\"default\" | \"hide\" | \"show\""
"\"default\" | \"show\" | \"hide\""
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false
@ -1435,7 +1435,7 @@
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
"\"data\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/layer_config.ts",
"deprecated": false
@ -2451,7 +2451,7 @@
"signature": [
"\"hide\" | \"inside\" | \"outside\""
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/xy_args.ts",
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"initialIsOpen": false
},
@ -4310,7 +4310,7 @@
"label": "LayerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
"\"data\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
@ -4401,6 +4401,20 @@
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.ValueLabelConfig",
"type": "Type",
"tags": [],
"label": "ValueLabelConfig",
"description": [],
"signature": [
"\"hide\" | \"inside\" | \"outside\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
@ -4429,13 +4443,13 @@
},
{
"parentPluginId": "lens",
"id": "def-common.layerTypes.THRESHOLD",
"id": "def-common.layerTypes.REFERENCELINE",
"type": "string",
"tags": [],
"label": "THRESHOLD",
"label": "REFERENCELINE",
"description": [],
"signature": [
"\"threshold\""
"\"referenceLine\""
],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false

View file

@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 253 | 0 | 235 | 24 |
| 254 | 0 | 236 | 24 |
## Client

View file

@ -516,10 +516,6 @@
"plugin": "security",
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
},
{
"plugin": "security",
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
@ -2261,10 +2257,6 @@
"plugin": "security",
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
},
{
"plugin": "security",
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"

View file

@ -1013,6 +1013,46 @@
}
],
"returnComment": []
},
{
"parentPluginId": "lists",
"id": "def-server.ExceptionListClient.exportExceptionListAndItems",
"type": "Function",
"tags": [],
"label": "exportExceptionListAndItems",
"description": [],
"signature": [
"({ listId, id, namespaceType, }: ",
"ExportExceptionListAndItemsOptions",
") => Promise<",
{
"pluginId": "lists",
"scope": "server",
"docId": "kibListsPluginApi",
"section": "def-server.ExportExceptionListAndItemsReturn",
"text": "ExportExceptionListAndItemsReturn"
},
" | null>"
],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lists",
"id": "def-server.ExceptionListClient.exportExceptionListAndItems.$1",
"type": "Object",
"tags": [],
"label": "{\n listId,\n id,\n namespaceType,\n }",
"description": [],
"signature": [
"ExportExceptionListAndItemsOptions"
],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -2081,6 +2121,42 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "lists",
"id": "def-server.ExportExceptionListAndItemsReturn",
"type": "Interface",
"tags": [],
"label": "ExportExceptionListAndItemsReturn",
"description": [],
"path": "x-pack/plugins/lists/server/services/exception_lists/export_exception_list_and_items.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lists",
"id": "def-server.ExportExceptionListAndItemsReturn.exportData",
"type": "string",
"tags": [],
"label": "exportData",
"description": [],
"path": "x-pack/plugins/lists/server/services/exception_lists/export_exception_list_and_items.ts",
"deprecated": false
},
{
"parentPluginId": "lists",
"id": "def-server.ExportExceptionListAndItemsReturn.exportDetails",
"type": "Object",
"tags": [],
"label": "exportDetails",
"description": [],
"signature": [
"{ exported_exception_list_count: number; exported_exception_list_item_count: number; missing_exception_list_item_count: number; missing_exception_list_items: string[]; missing_exception_lists: string[]; missing_exception_lists_count: number; }"
],
"path": "x-pack/plugins/lists/server/services/exception_lists/export_exception_list_and_items.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lists",
"id": "def-server.ListsApiRequestHandlerContext",
@ -2738,15 +2814,13 @@
"signature": [
"Pick<",
"KibanaClient",
", \"monitoring\" | \"security\" | \"create\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
" | undefined): ",
"TransportRequestPromise",
"<",
"ApiResponse",
"<Record<string, any>, unknown>>; }; }"
" | undefined): Promise<",
"TransportResult",
"<TResponse, unknown>>; }; }"
],
"path": "x-pack/plugins/lists/server/types.ts",
"deprecated": false

View file

@ -18,7 +18,7 @@ Contact [Security detections response](https://github.com/orgs/elastic/teams/sec
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 150 | 0 | 143 | 38 |
| 155 | 0 | 148 | 39 |
## Client

View file

@ -196,7 +196,7 @@
"signature": [
"Pick<Pick<",
"CreateManagementItemArgs",
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"id\" | \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\" | \"capabilitiesId\" | \"redirectFrom\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"id\" | \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\" | \"capabilitiesId\" | \"redirectFrom\">"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
@ -221,7 +221,7 @@
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\" | \"capabilitiesId\" | \"redirectFrom\">) => ",
{
"pluginId": "management",
"scope": "public",
@ -249,7 +249,7 @@
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\">"
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\" | \"capabilitiesId\" | \"redirectFrom\">"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,

View file

@ -1264,6 +1264,21 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getMbFieldName",
"type": "Function",
"tags": [],
"label": "getMbFieldName",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getRootName",
@ -1498,10 +1513,10 @@
},
{
"parentPluginId": "maps",
"id": "def-public.IField.supportsAutoDomain",
"id": "def-public.IField.supportsFieldMetaFromLocalData",
"type": "Function",
"tags": [],
"label": "supportsAutoDomain",
"label": "supportsFieldMetaFromLocalData",
"description": [],
"signature": [
"() => boolean"
@ -1513,25 +1528,10 @@
},
{
"parentPluginId": "maps",
"id": "def-public.IField.supportsFieldMeta",
"id": "def-public.IField.supportsFieldMetaFromEs",
"type": "Function",
"tags": [],
"label": "supportsFieldMeta",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.canReadFromGeoJson",
"type": "Function",
"tags": [],
"label": "canReadFromGeoJson",
"label": "supportsFieldMetaFromEs",
"description": [],
"signature": [
"() => boolean"
@ -1720,6 +1720,21 @@
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.isMvt",
"type": "Function",
"tags": [],
"label": "isMvt",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getTooltipProperties",
@ -2926,9 +2941,9 @@
"label": "SourceEditorArgs",
"description": [],
"signature": [
"{ onChange: (...args: ",
"{ clearJoins: () => void; currentLayerType: string; hasJoins: boolean; onChange: (...args: ",
"OnSourceChangeArgs",
"[]) => void; currentLayerType?: string | undefined; }"
"[]) => Promise<void>; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/source.ts",
"deprecated": false,

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 |
|-------------------|-----------|------------------------|-----------------|
| 202 | 0 | 201 | 29 |
| 203 | 0 | 202 | 29 |
## Client

View file

@ -572,7 +572,7 @@
"label": "MapsEmsConfig",
"description": [],
"signature": [
"{ readonly proxyElasticMapsServiceInMaps: boolean; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
"{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
],
"path": "src/plugins/maps_ems/config.ts",
"deprecated": false,
@ -612,7 +612,7 @@
"label": "config",
"description": [],
"signature": [
"{ readonly proxyElasticMapsServiceInMaps: boolean; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
"{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
],
"path": "src/plugins/maps_ems/public/index.ts",
"deprecated": false
@ -713,7 +713,7 @@
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
"<Readonly<{} & { tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
],
"path": "src/plugins/maps_ems/server/index.ts",
"deprecated": false
@ -746,7 +746,7 @@
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
"<Readonly<{} & { tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
],
"path": "src/plugins/maps_ems/server/index.ts",
"deprecated": false,
@ -771,7 +771,7 @@
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => { config: Readonly<{} & { proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
"<object, unknown>) => { config: Readonly<{} & { tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
],
"path": "src/plugins/maps_ems/server/index.ts",
"deprecated": false,
@ -839,7 +839,7 @@
"label": "config",
"description": [],
"signature": [
"{ readonly proxyElasticMapsServiceInMaps: boolean; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
"{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
],
"path": "src/plugins/maps_ems/server/index.ts",
"deprecated": false
@ -908,7 +908,7 @@
"label": "DEFAULT_EMS_LANDING_PAGE_URL",
"description": [],
"signature": [
"\"https://maps.elastic.co/v7.16\""
"\"https://maps.elastic.co/v8.0\""
],
"path": "src/plugins/maps_ems/common/index.ts",
"deprecated": false,

View file

@ -58,15 +58,13 @@
"signature": [
"Pick<",
"KibanaClient",
", \"monitoring\" | \"security\" | \"create\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
" | undefined): ",
"TransportRequestPromise",
"<",
"ApiResponse",
"<Record<string, any>, unknown>>; }; }"
" | undefined): Promise<",
"TransportResult",
"<TResponse, unknown>>; }; }"
],
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"deprecated": false

View file

@ -1055,7 +1055,7 @@
},
"<",
"MlAnomalyDetectionAlertParams",
">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
],
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"deprecated": false
@ -1327,7 +1327,7 @@
"label": "ML_PAGES",
"description": [],
"signature": [
"{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly DATA_FRAME_ANALYTICS_MODELS_MANAGE: \"data_frame_analytics/models\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }"
"{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly TRAINED_MODELS_NODES: \"trained_models/nodes\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }"
],
"path": "x-pack/plugins/ml/common/constants/locator.ts",
"deprecated": false,
@ -1531,7 +1531,7 @@
"section": "def-server.IScopedClusterClient",
"text": "IScopedClusterClient"
},
", indexPatternTitle: string, query: any, fields: ",
", indexPattern: string, query: any, fields: ",
"HistogramField",
"[], samplerShardSize: number, runtimeMappings?: Record<string, ",
"MappingRuntimeField",
@ -1565,7 +1565,7 @@
"id": "def-server.getHistogramsForFields.$2",
"type": "string",
"tags": [],
"label": "indexPatternTitle",
"label": "indexPattern",
"description": [],
"signature": [
"string"
@ -2890,7 +2890,7 @@
},
"<",
"MlAnomalyDetectionAlertParams",
">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
],
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"deprecated": false

View file

@ -149,7 +149,7 @@
"signature": [
"{ ui: { elasticsearch: ",
"MonitoringElasticsearchConfig",
"; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; debug_mode: boolean; debug_log_path: string; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; render_react_app: boolean; }; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { interval: number; enabled: boolean; }>; }>; licensing: Readonly<{} & { api_polling_frequency: moment.Duration; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; }"
"; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; debug_mode: boolean; debug_log_path: string; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; kibana: Readonly<{} & { collection: Readonly<{} & { interval: number; enabled: boolean; }>; }>; licensing: Readonly<{} & { api_polling_frequency: moment.Duration; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; }"
],
"path": "x-pack/plugins/monitoring/server/config.ts",
"deprecated": false,

File diff suppressed because one or more lines are too long

View file

@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 258 | 1 | 257 | 12 |
| 268 | 1 | 267 | 15 |
## Client

View file

@ -116,20 +116,6 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "osquery",
"id": "def-common.DEFAULT_MAX_TABLE_QUERY_SIZE",
"type": "number",
"tags": [],
"label": "DEFAULT_MAX_TABLE_QUERY_SIZE",
"description": [],
"signature": [
"10000"
],
"path": "x-pack/plugins/osquery/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "osquery",
"id": "def-common.OSQUERY_INTEGRATION_NAME",

View file

@ -18,7 +18,7 @@ Contact [Security asset management](https://github.com/orgs/elastic/teams/securi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 11 | 0 | 11 | 0 |
| 10 | 0 | 10 | 0 |
## Client

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 |
|--------------|----------|------------------------|
| 200 | 157 | 32 |
| 201 | 158 | 32 |
### Public API health stats
| API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------|
| 24503 | 264 | 19863 | 1594 |
| 24628 | 265 | 19978 | 1649 |
## Plugin Directory
@ -32,13 +32,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibBfetchPluginApi" text="bfetch"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 76 | 1 | 67 | 2 |
| <DocLink id="kibCanvasPluginApi" text="canvas"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 |
| <DocLink id="kibCasesPluginApi" text="cases"/> | [Security Solution Threat Hunting](https://github.com/orgs/elastic/teams/security-threat-hunting) | The Case management system in Kibana | 476 | 0 | 432 | 14 |
| <DocLink id="kibChartsPluginApi" text="charts"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 285 | 4 | 253 | 3 |
| <DocLink id="kibChartsPluginApi" text="charts"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 286 | 4 | 254 | 3 |
| <DocLink id="kibCloudPluginApi" text="cloud"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 22 | 0 | 22 | 0 |
| <DocLink id="kibConsolePluginApi" text="console"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2304 | 27 | 1023 | 29 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2304 | 27 | 1022 | 29 |
| crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <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 | 100 | 1 | 84 | 1 |
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 147 | 1 | 134 | 10 |
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 153 | 1 | 140 | 12 |
| <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. | 3238 | 40 | 2848 | 48 |
| <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 |
@ -65,7 +65,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibFeaturesPluginApi" text="features"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 216 | 0 | 98 | 2 |
| <DocLink id="kibFieldFormatsPluginApi" text="fieldFormats"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 284 | 7 | 246 | 3 |
| <DocLink id="kibFileUploadPluginApi" text="fileUpload"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 129 | 4 | 129 | 1 |
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1225 | 15 | 1122 | 10 |
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1223 | 15 | 1121 | 10 |
| <DocLink id="kibGlobalSearchPluginApi" text="globalSearch"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 |
| globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
| globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
@ -81,20 +81,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| ingestPipelines | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| inputControlVis | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 |
| <DocLink id="kibInspectorPluginApi" text="inspector"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 6 | 96 | 4 |
| <DocLink id="kibInteractiveSetupPluginApi" text="interactiveSetup"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 26 | 0 | 16 | 0 |
| <DocLink id="kibInteractiveSetupPluginApi" text="interactiveSetup"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 27 | 0 | 17 | 0 |
| <DocLink id="kibKibanaLegacyPluginApi" text="kibanaLegacy"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 12 | 0 | 9 | 0 |
| <DocLink id="kibKibanaOverviewPluginApi" text="kibanaOverview"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 |
| <DocLink id="kibKibanaReactPluginApi" text="kibanaReact"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 282 | 2 | 245 | 5 |
| kibanaUsageCollection | [Kibana Telemtry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibKibanaUtilsPluginApi" text="kibanaUtils"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 607 | 3 | 414 | 8 |
| <DocLink id="kibLensPluginApi" text="lens"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 253 | 0 | 235 | 24 |
| <DocLink id="kibKibanaUtilsPluginApi" text="kibanaUtils"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 8 |
| <DocLink id="kibLensPluginApi" text="lens"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 254 | 0 | 236 | 24 |
| <DocLink id="kibLicenseApiGuardPluginApi" text="licenseApiGuard"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 |
| <DocLink id="kibLicenseManagementPluginApi" text="licenseManagement"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 |
| <DocLink id="kibLicensingPluginApi" text="licensing"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 8 |
| <DocLink id="kibListsPluginApi" text="lists"/> | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 155 | 0 | 148 | 39 |
| 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) | - | 40 | 0 | 40 | 5 |
| <DocLink id="kibMapsPluginApi" text="maps"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 202 | 0 | 201 | 29 |
| <DocLink id="kibMapsPluginApi" text="maps"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 203 | 0 | 202 | 29 |
| <DocLink id="kibMapsEmsPluginApi" text="mapsEms"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 64 | 1 | 64 | 0 |
| <DocLink id="kibMetricsEntitiesPluginApi" text="metricsEntities"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 9 | 0 | 6 | 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. | 282 | 10 | 278 | 33 |
@ -104,11 +104,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibObservabilityPluginApi" text="observability"/> | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 268 | 1 | 267 | 15 |
| <DocLink id="kibOsqueryPluginApi" text="osquery"/> | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 10 | 0 | 10 | 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). | 178 | 3 | 151 | 6 |
| <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). | 262 | 4 | 234 | 12 |
| <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. | 137 | 0 | 136 | 12 |
| <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) | - | 151 | 0 | 128 | 7 |
| <DocLink id="kibRuleRegistryPluginApi" text="ruleRegistry"/> | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 153 | 0 | 127 | 7 |
| <DocLink id="kibRuntimeFieldsPluginApi" text="runtimeFields"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 |
| <DocLink id="kibSavedObjectsPluginApi" text="savedObjects"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 221 | 3 | 207 | 4 |
| <DocLink id="kibSavedObjectsManagementPluginApi" text="savedObjectsManagement"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 103 | 0 | 90 | 0 |
@ -116,7 +116,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibSavedObjectsTaggingOssPluginApi" text="savedObjectsTaggingOss"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 3 | 51 | 0 |
| <DocLink id="kibScreenshotModePluginApi" text="screenshotMode"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 22 | 0 | 17 | 1 |
| searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibSecurityPluginApi" text="security"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 116 | 0 | 54 | 8 |
| <DocLink id="kibSecurityPluginApi" text="security"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 108 | 0 | 47 | 8 |
| <DocLink id="kibSecuritySolutionPluginApi" text="securitySolution"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 1372 | 8 | 1318 | 33 |
| <DocLink id="kibSharePluginApi" text="share"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 143 | 1 | 90 | 10 |
| <DocLink id="kibSnapshotRestorePluginApi" text="snapshotRestore"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 23 | 1 | 23 | 1 |
@ -178,13 +178,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibKbnLoggingPluginApi" text="@kbn/logging"/> | [Owner missing] | - | 30 | 0 | 5 | 37 |
| <DocLink id="kibKbnMapboxGlPluginApi" text="@kbn/mapbox-gl"/> | [Owner missing] | - | 467 | 9 | 378 | 0 |
| <DocLink id="kibKbnMonacoPluginApi" text="@kbn/monaco"/> | [Owner missing] | - | 38 | 0 | 38 | 3 |
| <DocLink id="kibKbnOptimizerPluginApi" text="@kbn/optimizer"/> | [Owner missing] | - | 44 | 0 | 44 | 9 |
| <DocLink id="kibKbnOptimizerPluginApi" text="@kbn/optimizer"/> | [Owner missing] | - | 45 | 0 | 45 | 9 |
| <DocLink id="kibKbnPluginGeneratorPluginApi" text="@kbn/plugin-generator"/> | [Owner missing] | - | 1 | 0 | 1 | 0 |
| <DocLink id="kibKbnPluginHelpersPluginApi" text="@kbn/plugin-helpers"/> | [Owner missing] | Just some helpers for kibana plugin devs. | 1 | 0 | 1 | 0 |
| <DocLink id="kibKbnPmPluginApi" text="@kbn/pm"/> | [Owner missing] | - | 63 | 0 | 49 | 5 |
| <DocLink id="kibKbnRuleDataUtilsPluginApi" text="@kbn/rule-data-utils"/> | [Owner missing] | - | 74 | 0 | 71 | 0 |
| <DocLink id="kibKbnRuleDataUtilsPluginApi" text="@kbn/rule-data-utils"/> | [Owner missing] | - | 75 | 0 | 72 | 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... | 54 | 0 | 51 | 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 | 0 |
| <DocLink id="kibKbnSecuritysolutionHookUtilsPluginApi" text="@kbn/securitysolution-hook-utils"/> | [Owner missing] | Security Solution utilities for React hooks | 8 | 0 | 1 | 1 |
| <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 | 1 | 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 | 419 | 1 | 410 | 0 |
@ -194,6 +194,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <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="kibKbnSecuritysolutionListUtilsPluginApi" text="@kbn/securitysolution-list-utils"/> | [Owner missing] | security solution list utilities | 223 | 0 | 178 | 0 |
| <DocLink id="kibKbnSecuritysolutionRulesPluginApi" text="@kbn/securitysolution-rules"/> | [Owner missing] | security solution rule utilities to use across plugins | 23 | 0 | 21 | 0 |
| <DocLink id="kibKbnSecuritysolutionTGridPluginApi" text="@kbn/securitysolution-t-grid"/> | [Owner missing] | security solution t-grid packages will allow sharing components between timelines and security_solution plugin until we transfer all functionality to timelines plugin | 120 | 0 | 116 | 0 |
| <DocLink id="kibKbnSecuritysolutionUtilsPluginApi" text="@kbn/securitysolution-utils"/> | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 6 | 0 | 4 | 0 |
| <DocLink id="kibKbnServerHttpToolsPluginApi" text="@kbn/server-http-tools"/> | [Owner missing] | - | 53 | 0 | 50 | 1 |
@ -201,7 +202,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibKbnStdPluginApi" text="@kbn/std"/> | [Owner missing] | - | 96 | 1 | 63 | 2 |
| <DocLink id="kibKbnStorybookPluginApi" text="@kbn/storybook"/> | [Owner missing] | - | 18 | 1 | 18 | 0 |
| <DocLink id="kibKbnTelemetryToolsPluginApi" text="@kbn/telemetry-tools"/> | [Owner missing] | - | 2 | 0 | 2 | 0 |
| <DocLink id="kibKbnTestPluginApi" text="@kbn/test"/> | [Owner missing] | - | 200 | 5 | 177 | 9 |
| <DocLink id="kibKbnTestPluginApi" text="@kbn/test"/> | [Owner missing] | - | 203 | 5 | 180 | 9 |
| <DocLink id="kibKbnTypedReactRouterConfigPluginApi" text="@kbn/typed-react-router-config"/> | [Owner missing] | - | 78 | 0 | 78 | 1 |
| <DocLink id="kibKbnUtilityTypesPluginApi" text="@kbn/utility-types"/> | [Owner missing] | - | 29 | 1 | 10 | 1 |
| <DocLink id="kibKbnUtilsPluginApi" text="@kbn/utils"/> | [Owner missing] | - | 31 | 1 | 21 | 0 |

File diff suppressed because it is too large Load diff

View file

@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 178 | 3 | 151 | 6 |
| 262 | 4 | 234 | 12 |
## Client

View file

@ -944,13 +944,20 @@
},
{
"parentPluginId": "reporting",
"id": "def-server.ReportingCore.getKibanaVersion",
"id": "def-server.ReportingCore.getKibanaPackageInfo",
"type": "Function",
"tags": [],
"label": "getKibanaVersion",
"label": "getKibanaPackageInfo",
"description": [],
"signature": [
"() => string"
"() => ",
{
"pluginId": "@kbn/config",
"scope": "server",
"docId": "kibKbnConfigPluginApi",
"section": "def-server.PackageInfo",
"text": "PackageInfo"
}
],
"path": "x-pack/plugins/reporting/server/core.ts",
"deprecated": false,
@ -1559,6 +1566,59 @@
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-server.ReportingCore.getDataViewsService",
"type": "Function",
"tags": [],
"label": "getDataViewsService",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewsService",
"text": "DataViewsService"
},
">"
],
"path": "x-pack/plugins/reporting/server/core.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-server.ReportingCore.getDataViewsService.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/reporting/server/core.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-server.ReportingCore.getDataService",

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 |
|-------------------|-----------|------------------------|-----------------|
| 135 | 0 | 134 | 12 |
| 137 | 0 | 136 | 12 |
## Client

View file

@ -50,6 +50,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "rollup",
"id": "def-common.MAJOR_VERSION",
"type": "string",
"tags": [],
"label": "MAJOR_VERSION",
"description": [],
"signature": [
"\"8.0.0\""
],
"path": "x-pack/plugins/rollup/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "rollup",
"id": "def-common.UIM_APP_LOAD",

View file

@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 20 | 0 | 20 | 0 |
| 21 | 0 | 21 | 0 |
## Common

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show more