github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

API Doc Fixes (#109685) (#110466)

Browse source 
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/charts.mdx
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.json
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/expression_shape.json
#	api_docs/expression_shape.mdx
#	api_docs/expressions.json
#	api_docs/field_formats.json
#	api_docs/fleet.json
#	api_docs/kibana_react.json
#	api_docs/kibana_react.mdx
#	api_docs/lists.json
#	api_docs/observability.json
#	api_docs/reporting.json
#	api_docs/rule_registry.json
#	api_docs/rule_registry.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
#	api_docs/timelines.json
#	api_docs/timelines.mdx
#	api_docs/visualizations.mdx
This commit is contained in:
Stacey Gammon 2021-08-30 11:02:04 -04:00 • committed by GitHub
parent f7eec7d358
commit 53fa5ff3fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
189 changed files with 21178 additions and 18099 deletions
Download patch file Download diff file Expand all files Collapse all files

36
api_docs/actions.json
View file

@ -653,7 +653,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }"
"{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
"deprecated": false,
@ -875,7 +875,7 @@
"section": "def-common.ActionType",
"text": "ActionType"
},
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }"
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; }"
],
"path": "x-pack/plugins/actions/server/index.ts",
"deprecated": false,
@ -1091,6 +1091,36 @@
}
],
"returnComment": []
},
{
"parentPluginId": "actions",
"id": "def-server.PluginSetupContract.isPreconfiguredConnector",
"type": "Function",
"tags": [],
"label": "isPreconfiguredConnector",
"description": [],
"signature": [
"(connectorId: string) => boolean"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-server.PluginSetupContract.isPreconfiguredConnector.$1",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
@ -1248,7 +1278,7 @@
"section": "def-server.ActionsClient",
"text": "ActionsClient"
},
", \"get\" | \"delete\" | \"create\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"ephemeralEnqueuedExecution\" | \"listTypes\" | \"isActionTypeEnabled\">>"
", \"get\" | \"delete\" | \"create\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"ephemeralEnqueuedExecution\" | \"listTypes\" | \"isActionTypeEnabled\" | \"isPreconfigured\">>"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,

4
api_docs/actions.mdx
View file

@ -12,13 +12,13 @@ import actionsObj from './actions.json';
Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 119 | 0 | 119 | 7 |
| 121 | 0 | 121 | 7 |
## Server

176
api_docs/alerting.json
View file

@ -24,7 +24,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
"JsonObject"
],
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
@ -41,7 +41,7 @@
"label": "alert",
"description": [],
"signature": [
"{ enabled: boolean; id: string; name: string; params: never; actions: ",
"{ enabled: boolean; id: string; name: string; tags: string[]; params: never; actions: ",
{
"pluginId": "alerting",
"scope": "common",
@ -49,7 +49,7 @@
"section": "def-common.AlertAction",
"text": "AlertAction"
},
"[]; throttle: string | null; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
@ -326,7 +326,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 exemptConsumerIds,\n }",
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n auditLogger,\n getSpace,\n getSpaceId,\n }",
"description": [],
"signature": [
"ConstructorOptions"
@ -555,6 +555,114 @@
],
"returnComment": []
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertingAuthorization.getAuthorizationFilter",
"type": "Function",
"tags": [],
"label": "getAuthorizationFilter",
"description": [],
"signature": [
"(authorizationEntity: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertingAuthorizationEntity",
"text": "AlertingAuthorizationEntity"
},
", filterOpts: ",
"AlertingAuthorizationFilterOpts",
", operation: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.ReadOperations",
"text": "ReadOperations"
},
" | ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.WriteOperations",
"text": "WriteOperations"
},
") => Promise<{ filter?: ",
"KueryNode",
" | ",
"JsonObject",
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$1",
"type": "Enum",
"tags": [],
"label": "authorizationEntity",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertingAuthorizationEntity",
"text": "AlertingAuthorizationEntity"
}
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$2",
"type": "Object",
"tags": [],
"label": "filterOpts",
"description": [],
"signature": [
"AlertingAuthorizationFilterOpts"
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$3",
"type": "CompoundType",
"tags": [],
"label": "operation",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.ReadOperations",
"text": "ReadOperations"
},
" | ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.WriteOperations",
"text": "WriteOperations"
}
],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization",
@ -900,7 +1008,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"actions\" | \"throttle\" | \"tags\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"tags\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
@ -1499,7 +1607,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false
@ -1616,7 +1724,7 @@
"section": "def-server.RulesClient",
"text": "RulesClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
", \"get\" | \"delete\" | \"create\" | \"find\" | \"resolve\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\" | \"getSpaceId\">"
],
"path": "x-pack/plugins/alerting/server/plugin.ts",
"deprecated": false,
@ -1669,7 +1777,7 @@
"section": "def-server.AlertingAuthorization",
"text": "AlertingAuthorization"
},
", \"ensureAuthorized\" | \"getSpaceId\" | \"getAugmentedRuleTypesWithAuthorization\" | \"getFindAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
", \"ensureAuthorized\" | \"getSpaceId\" | \"getAugmentedRuleTypesWithAuthorization\" | \"getFindAuthorizationFilter\" | \"getAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
],
"path": "x-pack/plugins/alerting/server/plugin.ts",
"deprecated": false,
@ -1960,7 +2068,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
"<Params>, \"enabled\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
@ -2002,7 +2110,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"CreateOptions",
"<Params>) => Promise<Pick<",
{
@ -2012,7 +2120,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: ",
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: ",
"FindOptions",
" | undefined; }) => Promise<",
{
@ -2022,6 +2130,14 @@
"section": "def-server.FindResult",
"text": "FindResult"
},
"<Params>>; resolve: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule"
},
"<Params>>; update: <Params extends Record<string, unknown> = never>({ id, data, }: ",
"UpdateOptions",
"<Params>) => Promise<",
@ -2052,7 +2168,7 @@
"MuteOptions",
") => Promise<void>; listAlertTypes: () => Promise<Set<",
"RegistryAlertTypeWithAuth",
">>; }"
">>; getSpaceId: () => string | undefined; }"
],
"path": "x-pack/plugins/alerting/server/index.ts",
"deprecated": false,
@ -3861,6 +3977,36 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ResolvedSanitizedRule",
"type": "Type",
"tags": [],
"label": "ResolvedSanitizedRule",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> & Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<unknown>, \"outcome\" | \"alias_target_id\">"
],
"path": "x-pack/plugins/alerting/common/alert.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.SanitizedAlert",
@ -3869,7 +4015,7 @@
"label": "SanitizedAlert",
"description": [],
"signature": [
"{ enabled: boolean; id: string; name: string; params: Params; actions: ",
"{ enabled: boolean; id: string; name: string; tags: string[]; params: Params; actions: ",
{
"pluginId": "alerting",
"scope": "common",
@ -3877,7 +4023,7 @@
"section": "def-common.AlertAction",
"text": "AlertAction"
},
"[]; throttle: string | null; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
@ -3915,7 +4061,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"actions\" | \"throttle\" | \"tags\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"tags\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/common/alert.ts",
"deprecated": false,

4
api_docs/alerting.mdx
View file

@ -12,13 +12,13 @@ import alertingObj from './alerting.json';
Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 243 | 0 | 235 | 16 |
| 248 | 0 | 240 | 16 |
## Client

744
api_docs/apm.json
View file

File diff suppressed because it is too large Load diff

4
api_docs/apm.mdx
View file

@ -12,13 +12,13 @@ import apmObj from './apm.json';
Contact APM UI for questions regarding this plugin.
Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 42 | 0 | 42 | 29 |
| 42 | 0 | 42 | 30 |
## Client

28
api_docs/apm_oss.json
View file

@ -6,7 +6,33 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"setup": {
"parentPluginId": "apmOss",
"id": "def-public.ApmOssPluginSetup",
"type": "Interface",
"tags": [],
"label": "ApmOssPluginSetup",
"description": [],
"path": "src/plugins/apm_oss/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "apmOss",
"id": "def-public.ApmOssPluginStart",
"type": "Interface",
"tags": [],
"label": "ApmOssPluginStart",
"description": [],
"path": "src/plugins/apm_oss/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],

12
api_docs/apm_oss.mdx
View file

@ -12,13 +12,21 @@ import apmOssObj from './apm_oss.json';
Contact APM UI for questions regarding this plugin.
Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 0 |
| 6 | 0 | 6 | 0 |
## Client
### Setup
<DocDefinitionList data={[apmOssObj.client.setup]}/>
### Start
<DocDefinitionList data={[apmOssObj.client.start]}/>
## Server

2
api_docs/banners.mdx
View file

@ -12,7 +12,7 @@ import bannersObj from './banners.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**

4
api_docs/canvas.mdx
View file

@ -10,9 +10,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import canvasObj from './canvas.json';
Adds Canvas application to Kibana
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**

535
api_docs/cases.json
View file

@ -530,6 +530,21 @@
"description": [],
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-public.AllCasesSelectorModalProps.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
@ -2731,6 +2746,32 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiConfigType",
"type": "Interface",
"tags": [],
"label": "CasesUiConfigType",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesUiConfigType.markdownPlugins",
"type": "Object",
"tags": [],
"label": "markdownPlugins",
"description": [],
"signature": [
"{ lens: boolean; }"
],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions",
@ -2759,7 +2800,7 @@
"label": "actionField",
"description": [],
"signature": [
"(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
"(\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
@ -3019,78 +3060,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector",
"type": "Interface",
"tags": [],
"label": "ESCaseConnector",
"description": [],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
}
],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.fields",
"type": "CompoundType",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESConnectorFields",
"text": "ESConnectorFields"
},
" | null"
],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FetchCasesProps",
@ -4848,7 +4817,7 @@
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; 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; }"
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: { connector_id: string | null; connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; 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; }"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,
@ -4938,7 +4907,7 @@
"label": "CaseFullExternalService",
"description": [],
"signature": [
"({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null"
"{ connector_id: string | null; connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; } | null"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,
@ -5164,7 +5133,7 @@
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: { connector_id: string | null; connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
@ -5894,7 +5863,7 @@
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: { connector_id: string | null; connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
@ -6170,7 +6139,7 @@
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: { connector_id: string | null; connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; 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; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
@ -6390,7 +6359,7 @@
"label": "CaseUserActionAttributes",
"description": [],
"signature": [
"{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; }"
"{ action_field: (\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; }"
],
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"deprecated": false,
@ -6404,7 +6373,7 @@
"label": "CaseUserActionResponse",
"description": [],
"signature": [
"{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; }"
"{ action_field: (\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; }"
],
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"deprecated": false,
@ -6418,7 +6387,7 @@
"label": "CaseUserActionsResponse",
"description": [],
"signature": [
"({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]"
"({ action_field: (\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]"
],
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"deprecated": false,
@ -7366,282 +7335,6 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseAttributes",
"type": "Type",
"tags": [],
"label": "ESCaseAttributes",
"description": [],
"signature": [
"Pick<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; 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; }, \"type\" | \"status\" | \"description\" | \"title\" | \"updated_at\" | \"tags\" | \"settings\" | \"owner\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closed_at\" | \"closed_by\" | \"external_service\"> & { connector: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
"; }"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnectorTypes",
"type": "Type",
"tags": [],
"label": "ESCaseConnectorTypes",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
}
],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCasePatchRequest",
"type": "Type",
"tags": [],
"label": "ESCasePatchRequest",
"description": [],
"signature": [
"Pick<{ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; owner?: string | undefined; } & { id: string; version: string; }, \"type\" | \"status\" | \"description\" | \"title\" | \"id\" | \"version\" | \"tags\" | \"settings\" | \"owner\"> & { connector?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
" | undefined; }"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCasesConfigureAttributes",
"type": "Type",
"tags": [],
"label": "ESCasesConfigureAttributes",
"description": [],
"signature": [
"Pick<{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }, \"updated_at\" | \"owner\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closure_type\"> & { connector: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
"; }"
],
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESConnectorFields",
"type": "Type",
"tags": [],
"label": "ESConnectorFields",
"description": [],
"signature": [
"{ key: string; value: unknown; }[]"
],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ExternalServiceResponse",
@ -7800,6 +7493,17 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.noneConnectorId",
"type": "string",
"tags": [],
"label": "noneConnectorId",
"description": [],
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.OWNER_FIELD",
@ -8404,7 +8108,7 @@
"label": "UserActionField",
"description": [],
"signature": [
"(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
"(\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
],
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"deprecated": false,
@ -8418,7 +8122,7 @@
"label": "UserActionFieldType",
"description": [],
"signature": [
"\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\""
"\"status\" | \"description\" | \"title\" | \"tags\" | \"comment\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\""
],
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"deprecated": false,
@ -9997,12 +9701,14 @@
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"UnionC",
"<[",
"StringC",
"; connector_name: ",
", ",
"NullC",
"]>; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
@ -10010,9 +9716,7 @@
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"; pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
@ -10040,7 +9744,7 @@
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"]>; }>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
@ -11389,6 +11093,63 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalServiceBasicRt",
"type": "Object",
"tags": [],
"label": "CaseExternalServiceBasicRt",
"description": [],
"signature": [
"TypeC",
"<{ connector_id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
"; external_title: ",
"StringC",
"; external_url: ",
"StringC",
"; pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; }>"
],
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePatchRequestRt",
@ -12378,12 +12139,14 @@
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"UnionC",
"<[",
"StringC",
"; connector_name: ",
", ",
"NullC",
"]>; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
@ -12391,9 +12154,7 @@
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"; pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
@ -12421,7 +12182,7 @@
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"]>; }>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
@ -14961,12 +14722,14 @@
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"UnionC",
"<[",
"StringC",
"; connector_name: ",
", ",
"NullC",
"]>; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
@ -14974,9 +14737,7 @@
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"; pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
@ -15004,7 +14765,7 @@
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"]>; }>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
@ -16925,12 +16686,14 @@
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"UnionC",
"<[",
"StringC",
"; connector_name: ",
", ",
"NullC",
"]>; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
@ -16938,9 +16701,7 @@
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"; pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
@ -16968,7 +16729,7 @@
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"]>; }>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",

2
api_docs/cases.mdx
View file

@ -18,7 +18,7 @@ Contact [Security Solution Threat Hunting](https://github.com/orgs/elastic/teams
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 459 | 0 | 417 | 14 |
| 454 | 0 | 412 | 14 |
## Client

315
api_docs/charts.json
View file

@ -2631,9 +2631,316 @@
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"interfaces": [
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments",
"type": "Interface",
"tags": [],
"label": "CustomPaletteArguments",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.color",
"type": "Array",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.gradient",
"type": "boolean",
"tags": [],
"label": "gradient",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.reverse",
"type": "CompoundType",
"tags": [],
"label": "reverse",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.stop",
"type": "Array",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"number[] | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.range",
"type": "CompoundType",
"tags": [],
"label": "range",
"description": [],
"signature": [
"\"number\" | \"percent\" | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.rangeMin",
"type": "number",
"tags": [],
"label": "rangeMin",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.rangeMax",
"type": "number",
"tags": [],
"label": "rangeMax",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteArguments.continuity",
"type": "CompoundType",
"tags": [],
"label": "continuity",
"description": [],
"signature": [
"\"above\" | \"below\" | \"all\" | \"none\" | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState",
"type": "Interface",
"tags": [],
"label": "CustomPaletteState",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.colors",
"type": "Array",
"tags": [],
"label": "colors",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.gradient",
"type": "boolean",
"tags": [],
"label": "gradient",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.stops",
"type": "Array",
"tags": [],
"label": "stops",
"description": [],
"signature": [
"number[]"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.range",
"type": "CompoundType",
"tags": [],
"label": "range",
"description": [],
"signature": [
"\"number\" | \"percent\""
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.rangeMin",
"type": "number",
"tags": [],
"label": "rangeMin",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.rangeMax",
"type": "number",
"tags": [],
"label": "rangeMax",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.CustomPaletteState.continuity",
"type": "CompoundType",
"tags": [],
"label": "continuity",
"description": [],
"signature": [
"\"above\" | \"below\" | \"all\" | \"none\" | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-server.PaletteOutput",
"type": "Interface",
"tags": [],
"label": "PaletteOutput",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<T>"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-server.PaletteOutput.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"palette\""
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.PaletteOutput.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
},
{
"parentPluginId": "charts",
"id": "def-server.PaletteOutput.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-server.SystemPaletteArguments",
"type": "Interface",
"tags": [],
"label": "SystemPaletteArguments",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-server.SystemPaletteArguments.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/charts/common/palette.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "charts",
"id": "def-server.paletteIds",
"type": "Array",
"tags": [],
"label": "paletteIds",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/charts/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
@ -2696,7 +3003,7 @@
"text": "Adapters"
},
", ",
"Serializable",
"SerializableRecord",
">>"
],
"path": "src/plugins/charts/common/palette.ts",
@ -2754,7 +3061,7 @@
"text": "Adapters"
},
", ",
"Serializable",
"SerializableRecord",
">>"
],
"path": "src/plugins/charts/common/palette.ts",

10
api_docs/charts.mdx
View file

@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 199 | 2 | 168 | 3 |
| 223 | 2 | 192 | 3 |
## Client
@ -43,6 +43,14 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
### Consts, variables and types
<DocDefinitionList data={chartsObj.client.misc}/>
## Server
### Interfaces
<DocDefinitionList data={chartsObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={chartsObj.server.misc}/>
## Common
### Functions

2
api_docs/cloud.mdx
View file

@ -12,7 +12,7 @@ import cloudObj from './cloud.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**

167
api_docs/console.json Normal file
View file

@ -0,0 +1,167 @@
{
"id": "console",
"client": {
"classes": [
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin",
"type": "Class",
"tags": [],
"label": "ConsoleUIPlugin",
"description": [],
"signature": [
{
"pluginId": "console",
"scope": "public",
"docId": "kibConsolePluginApi",
"section": "def-public.ConsoleUIPlugin",
"text": "ConsoleUIPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<void, void, ",
"AppSetupUIPluginDependencies",
", object>"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"({ notifications, getStartServices, http }: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { devTools, home, usageCollection }: ",
"AppSetupUIPluginDependencies",
") => void"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "{ notifications, getStartServices, http }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ devTools, home, usageCollection }",
"description": [],
"signature": [
"AppSetupUIPluginDependencies"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "console",
"id": "def-public.ConsoleUIPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/console/public/plugin.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "console",
"id": "def-server.ConsoleSetup",
"type": "Type",
"tags": [],
"label": "ConsoleSetup",
"description": [],
"signature": [
"{ addExtensionSpecFilePath: (path: string) => void; }"
],
"path": "src/plugins/console/server/types.ts",
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "console",
"id": "def-server.ConsoleStart",
"type": "Type",
"tags": [],
"label": "ConsoleStart",
"description": [],
"signature": [
"{ addProcessorDefinition: (processor: unknown) => void; }"
],
"path": "src/plugins/console/server/types.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

35
api_docs/console.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibConsolePluginApi
slug: /kibana-dev-docs/consolePluginApi
title: console
image: https://source.unsplash.com/400x175/?github
summary: API docs for the console plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
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 consoleObj from './console.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 7 | 0 | 7 | 1 |
## Client
### Classes
<DocDefinitionList data={consoleObj.client.classes}/>
## Server
### Setup
<DocDefinitionList data={[consoleObj.server.setup]}/>
### Start
<DocDefinitionList data={[consoleObj.server.start]}/>

3747
api_docs/core.json
View file

File diff suppressed because one or more lines are too long

4
api_docs/core.mdx
View file

@ -12,13 +12,13 @@ import coreObj from './core.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2454 | 149 | 1165 | 31 |
| 2249 | 27 | 998 | 30 |
## Client

48
api_docs/core_application.json
View file

@ -1388,6 +1388,18 @@
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/target/types/public/applications/integrations/index.d.ts"
},
{
"plugin": "kibanaOverview",
"path": "src/plugins/kibana_overview/public/application.tsx"
},
{
"plugin": "timelion",
"path": "src/plugins/timelion/public/application.ts"
},
{
"plugin": "management",
"path": "src/plugins/management/target/types/public/application.d.ts"
}
]
},
@ -1495,6 +1507,42 @@
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/public/application/components/visualize_top_nav.tsx"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/public/application/components/visualize_editor_common.tsx"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/public/application/app.tsx"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/public/application/index.tsx"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/target/types/public/types.d.ts"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/target/types/public/application/app.d.ts"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/target/types/public/application/index.d.ts"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/target/types/public/application/components/visualize_editor_common.d.ts"
},
{
"plugin": "visualize",
"path": "src/plugins/visualize/target/types/public/application/components/visualize_top_nav.d.ts"
}
],
"children": [

4
api_docs/core_application.mdx
View file

@ -12,13 +12,13 @@ import coreApplicationObj from './core_application.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2454 | 149 | 1165 | 31 |
| 2249 | 27 | 998 | 30 |
## Client

239
api_docs/core_chrome.json
View file

@ -50,45 +50,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.ChromeBrand",
"type": "Interface",
"tags": [],
"label": "ChromeBrand",
"description": [],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ChromeBrand.logo",
"type": "string",
"tags": [],
"label": "logo",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.ChromeBrand.smallLogo",
"type": "string",
"tags": [],
"label": "smallLogo",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.ChromeDocTitle",
@ -273,7 +234,7 @@
"CommonEuiButtonEmptyProps",
", {}>> & ",
"CommonEuiButtonEmptyProps",
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"data-test-subj\" | \"target\" | \"iconType\" | \"rel\">"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,
@ -362,7 +323,7 @@
"CommonEuiButtonEmptyProps",
", {}>> & ",
"CommonEuiButtonEmptyProps",
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"data-test-subj\" | \"target\" | \"iconType\" | \"rel\">"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,
@ -436,7 +397,7 @@
"CommonEuiButtonEmptyProps",
", {}>> & ",
"CommonEuiButtonEmptyProps",
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"data-test-subj\" | \"target\" | \"iconType\" | \"rel\">"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,
@ -510,7 +471,7 @@
"CommonEuiButtonEmptyProps",
", {}>> & ",
"CommonEuiButtonEmptyProps",
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"data-test-subj\" | \"target\" | \"iconType\" | \"rel\">"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,
@ -1436,111 +1397,6 @@
"path": "src/core/public/chrome/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.setAppTitle",
"type": "Function",
"tags": [],
"label": "setAppTitle",
"description": [
"\nSets the current app's title\n"
],
"signature": [
"(appTitle: string) => void"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.setAppTitle.$1",
"type": "string",
"tags": [],
"label": "appTitle",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.getBrand$",
"type": "Function",
"tags": [],
"label": "getBrand$",
"description": [
"\nGet an observable of the current brand information."
],
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
},
">"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.setBrand",
"type": "Function",
"tags": [],
"label": "setBrand",
"description": [
"\nSet the brand configuration.\n"
],
"signature": [
"(brand: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
},
") => void"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.setBrand.$1",
"type": "Object",
"tags": [],
"label": "brand",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
}
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.getIsVisible$",
@ -1592,89 +1448,6 @@
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.getApplicationClasses$",
"type": "Function",
"tags": [],
"label": "getApplicationClasses$",
"description": [
"\nGet the current set of classNames that will be set on the application container."
],
"signature": [
"() => ",
"Observable",
"<string[]>"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.addApplicationClass",
"type": "Function",
"tags": [],
"label": "addApplicationClass",
"description": [
"\nAdd a className that should be set on the application container."
],
"signature": [
"(className: string) => void"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.addApplicationClass.$1",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.removeApplicationClass",
"type": "Function",
"tags": [],
"label": "removeApplicationClass",
"description": [
"\nRemove a className added with `addApplicationClass()`. If className is unknown it is ignored."
],
"signature": [
"(className: string) => void"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.removeApplicationClass.$1",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.ChromeStart.getBadge$",
@ -2174,7 +1947,7 @@
"description": [],
"signature": [
"CommonProps",
" & { text: React.ReactNode; href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; truncate?: boolean | undefined; 'aria-current'?: boolean | \"date\" | \"location\" | \"page\" | \"true\" | \"false\" | \"step\" | \"time\" | undefined; }"
" & { text: React.ReactNode; href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; truncate?: boolean | undefined; 'aria-current'?: boolean | \"date\" | \"location\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | undefined; }"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
@ -2188,7 +1961,7 @@
"label": "ChromeHelpExtensionLinkBase",
"description": [],
"signature": [
"{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }"
"{ 'data-test-subj'?: string | undefined; target?: string | undefined; iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; rel?: string | undefined; }"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,

4
api_docs/core_chrome.mdx
View file

@ -12,13 +12,13 @@ import coreChromeObj from './core_chrome.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2454 | 149 | 1165 | 31 |
| 2249 | 27 | 998 | 30 |
## Client

308
api_docs/core_http.json
View file

@ -130,13 +130,7 @@
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IExecutionContextContainer",
"text": "IExecutionContextContainer"
},
"KibanaExecutionContext",
" | undefined"
],
"path": "src/core/public/http/types.ts",
@ -723,13 +717,7 @@
"text": "HttpHeadersInit"
},
" | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IExecutionContextContainer",
"text": "IExecutionContextContainer"
},
"KibanaExecutionContext",
" | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream<Uint8Array> | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }"
],
"path": "src/core/public/http/types.ts",
@ -1079,13 +1067,7 @@
"text": "HttpHeadersInit"
},
" | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IExecutionContextContainer",
"text": "IExecutionContextContainer"
},
"KibanaExecutionContext",
" | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream<Uint8Array> | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }"
],
"path": "src/core/public/http/types.ts",
@ -2035,15 +2017,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => string"
"<unknown, unknown, unknown, any>) => string"
],
"path": "src/core/server/http/base_path_service.ts",
"deprecated": false,
@ -2051,7 +2025,7 @@
{
"parentPluginId": "core",
"id": "def-server.BasePath.get.$1",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -2063,14 +2037,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/base_path_service.ts",
"deprecated": false,
@ -2099,15 +2066,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
", requestSpecificBasePath: string) => void"
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void"
],
"path": "src/core/server/http/base_path_service.ts",
"deprecated": false,
@ -2115,7 +2074,7 @@
{
"parentPluginId": "core",
"id": "def-server.BasePath.set.$1",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -2127,14 +2086,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/base_path_service.ts",
"deprecated": false,
@ -3078,15 +3030,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => { status: ",
"<unknown, unknown, unknown, any>) => { status: ",
{
"pluginId": "core",
"scope": "server",
@ -3103,7 +3047,7 @@
{
"parentPluginId": "core",
"id": "def-server.request",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -3115,14 +3059,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/auth_state_storage.ts",
"deprecated": false
@ -3147,15 +3084,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => boolean"
"<unknown, unknown, unknown, any>) => boolean"
],
"path": "src/core/server/http/types.ts",
"deprecated": false,
@ -3164,7 +3093,7 @@
{
"parentPluginId": "core",
"id": "def-server.request",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -3176,14 +3105,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/auth_state_storage.ts",
"deprecated": false
@ -3429,15 +3351,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => string; prepend: (path: string) => string; set: (request: ",
"<unknown, unknown, unknown, any>) => string; prepend: (path: string) => string; set: (request: ",
{
"pluginId": "core",
"scope": "server",
@ -3445,18 +3359,34 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
],
"path": "src/core/server/http/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.HttpServicePreboot.getServerInfo",
"type": "Function",
"tags": [],
"label": "getServerInfo",
"description": [
"\nProvides common {@link HttpServerInfo | information} about the running preboot http server."
],
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
", requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
"section": "def-server.HttpServerInfo",
"text": "HttpServerInfo"
}
],
"path": "src/core/server/http/types.ts",
"deprecated": false
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
@ -3776,15 +3706,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => string; prepend: (path: string) => string; set: (request: ",
"<unknown, unknown, unknown, any>) => string; prepend: (path: string) => string; set: (request: ",
{
"pluginId": "core",
"scope": "server",
@ -3792,15 +3714,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
", requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
],
"path": "src/core/server/http/types.ts",
"deprecated": false
@ -4022,15 +3936,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => string; prepend: (path: string) => string; set: (request: ",
"<unknown, unknown, unknown, any>) => string; prepend: (path: string) => string; set: (request: ",
{
"pluginId": "core",
"scope": "server",
@ -4038,15 +3944,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
", requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
],
"path": "src/core/server/http/types.ts",
"deprecated": false
@ -7491,7 +7389,7 @@
"section": "def-server.RouteConfigOptions",
"text": "RouteConfigOptions"
},
"<Method>, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<",
"<Method>, \"tags\" | \"timeout\" | \"authRequired\" | \"xsrfRequired\">> : Required<",
{
"pluginId": "core",
"scope": "server",
@ -7507,41 +7405,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.LegacyRequest",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "LegacyRequest",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
" extends ",
"Request"
],
"path": "src/core/server/http/router/request.ts",
"deprecated": true,
"references": [
{
"plugin": "security",
"path": "x-pack/plugins/security/server/saved_objects/index.ts"
},
{
"plugin": "security",
"path": "x-pack/plugins/security/server/saved_objects/index.ts"
}
],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.OnPostAuthToolkit",
@ -9239,15 +9102,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => Record<string, string | string[]> | undefined"
"<unknown, unknown, unknown, any>) => Record<string, string | string[]> | undefined"
],
"path": "src/core/server/http/auth_headers_storage.ts",
"deprecated": false,
@ -9258,7 +9113,7 @@
{
"parentPluginId": "core",
"id": "def-server.request",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -9270,14 +9125,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/auth_headers_storage.ts",
"deprecated": false
@ -9303,15 +9151,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => { status: ",
"<unknown, unknown, unknown, any>) => { status: ",
{
"pluginId": "core",
"scope": "server",
@ -9328,7 +9168,7 @@
{
"parentPluginId": "core",
"id": "def-server.request",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -9340,14 +9180,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/auth_state_storage.ts",
"deprecated": false
@ -9407,15 +9240,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => string; prepend: (path: string) => string; set: (request: ",
"<unknown, unknown, unknown, any>) => string; prepend: (path: string) => string; set: (request: ",
{
"pluginId": "core",
"scope": "server",
@ -9423,15 +9248,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
", requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"
],
"path": "src/core/server/http/base_path_service.ts",
"deprecated": false,
@ -9455,15 +9272,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
},
") => boolean"
"<unknown, unknown, unknown, any>) => boolean"
],
"path": "src/core/server/http/auth_state_storage.ts",
"deprecated": false,
@ -9472,7 +9281,7 @@
{
"parentPluginId": "core",
"id": "def-server.request",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
@ -9484,14 +9293,7 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.LegacyRequest",
"text": "LegacyRequest"
}
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/http/auth_state_storage.ts",
"deprecated": false
@ -9525,7 +9327,7 @@
"section": "def-server.RouteConfigOptions",
"text": "RouteConfigOptions"
},
"<Method>, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<",
"<Method>, \"tags\" | \"timeout\" | \"authRequired\" | \"xsrfRequired\">> : Required<",
{
"pluginId": "core",
"scope": "server",

4
api_docs/core_http.mdx
View file

@ -12,13 +12,13 @@ import coreHttpObj from './core_http.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2454 | 149 | 1165 | 31 |
| 2249 | 27 | 998 | 30 |
## Client

128
api_docs/core_saved_objects.json
View file

@ -995,10 +995,10 @@
"children": [
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject.savedObject",
"id": "def-public.ResolvedSimpleSavedObject.saved_object",
"type": "Object",
"tags": [],
"label": "savedObject",
"label": "saved_object",
"description": [
"\nThe saved object that was found."
],
@ -1032,10 +1032,10 @@
},
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject.aliasTargetId",
"id": "def-public.ResolvedSimpleSavedObject.alias_target_id",
"type": "string",
"tags": [],
"label": "aliasTargetId",
"label": "alias_target_id",
"description": [
"\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."
],
@ -4274,6 +4274,51 @@
}
],
"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
@ -9720,6 +9765,21 @@
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [
"\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -12518,13 +12578,13 @@
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": true,
"references": [
{
"plugin": "savedObjectsManagement",
"path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts"
},
{
"plugin": "spaces",
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx"
},
{
"plugin": "savedObjectsManagement",
"path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts"
}
]
},
@ -12879,14 +12939,6 @@
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": true,
"references": [
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts"
@ -12894,6 +12946,14 @@
{
"plugin": "lens",
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
}
],
"children": [
@ -13002,23 +13062,6 @@
"tags": [],
"label": "SavedObjectsOpenPointInTimeOptions",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
@ -13051,6 +13094,21 @@
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [
"\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -13563,10 +13621,10 @@
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveResponse.aliasTargetId",
"id": "def-server.SavedObjectsResolveResponse.alias_target_id",
"type": "string",
"tags": [],
"label": "aliasTargetId",
"label": "alias_target_id",
"description": [
"\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."
],

4
api_docs/core_saved_objects.mdx
View file

@ -12,13 +12,13 @@ import coreSavedObjectsObj from './core_saved_objects.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2454 | 149 | 1165 | 31 |
| 2249 | 27 | 998 | 30 |
## Client

396
api_docs/dashboard.json
View file

@ -1117,249 +1117,6 @@
}
],
"interfaces": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams",
"type": "Interface",
"tags": [],
"label": "DashboardAppLocatorParams",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardAppLocatorParams",
"text": "DashboardAppLocatorParams"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
}
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.dashboardId",
"type": "string",
"tags": [],
"label": "dashboardId",
"description": [
"\nIf given, the dashboard saved object with this id will be loaded. If not given,\na new, unsaved dashboard will be loaded up."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.refreshInterval",
"type": "CompoundType",
"tags": [],
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
"(",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" & ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
") | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters."
],
"signature": [
"Filter",
"[] | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
],
"signature": [
"Query",
" | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.useHash",
"type": "CompoundType",
"tags": [],
"label": "useHash",
"description": [
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.preserveSavedFilters",
"type": "CompoundType",
"tags": [],
"label": "preserveSavedFilters",
"description": [
"\nWhen `true` filters from saved filters from destination dashboard as merged with applied filters\nWhen `false` applied filters take precedence and override saved filters\n\ntrue is default"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.viewMode",
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": [
"\nView mode of the dashboard."
],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.ViewMode",
"text": "ViewMode"
},
" | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.searchSessionId",
"type": "string",
"tags": [],
"label": "searchSessionId",
"description": [
"\nSearch search session ID to restore.\n(Background search)"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.panels",
"type": "CompoundType",
"tags": [],
"label": "panels",
"description": [
"\nList of dashboard panels"
],
"signature": [
"(",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel730ToLatest",
"text": "SavedDashboardPanel730ToLatest"
},
"[] & ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
") | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams.savedQuery",
"type": "string",
"tags": [],
"label": "savedQuery",
"description": [
"\nSaved query ID"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput",
@ -1585,6 +1342,20 @@
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.executionContext",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [],
"signature": [
"KibanaExecutionContext",
" | undefined"
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -2293,6 +2064,60 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams",
"type": "Type",
"tags": [],
"label": "DashboardAppLocatorParams",
"description": [
"\nWe use `type` instead of `interface` to avoid having to extend this type with\n`SerializableRecord`. See https://github.com/microsoft/TypeScript/issues/15300."
],
"signature": [
"{ dashboardId?: string | undefined; timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; refreshInterval?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; filters?: ",
"Filter",
"[] | undefined; query?: ",
"Query",
" | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; viewMode?: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.ViewMode",
"text": "ViewMode"
},
" | undefined; searchSessionId?: string | undefined; panels?: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel730ToLatest",
"text": "SavedDashboardPanel730ToLatest"
},
"[] | undefined; savedQuery?: string | undefined; options?: ",
"DashboardOptions",
" | undefined; }"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardUrlGenerator",
@ -2626,7 +2451,9 @@
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">, embeddableType: string) => Promise<{ [key: string]: unknown; }[]>"
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">, embeddableType: string) => Promise<{ [key: string]: ",
"Serializable",
"; }[]>"
],
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
"deprecated": false,
@ -2754,7 +2581,9 @@
"section": "def-common.SavedDashboardPanel630",
"text": "SavedDashboardPanel630"
},
")[], version: string, useMargins: boolean, uiState: { [key: string]: { [key: string]: unknown; }; } | undefined) => ",
")[], version: string, useMargins: boolean, uiState: { [key: string]: ",
"SerializableRecord",
"; } | undefined) => ",
{
"pluginId": "dashboard",
"scope": "common",
@ -2932,69 +2761,6 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData",
"type": "Interface",
"tags": [],
"label": "GridData",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.w",
"type": "number",
"tags": [],
"label": "w",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.h",
"type": "number",
"tags": [],
"label": "h",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.x",
"type": "number",
"tags": [],
"label": "x",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.y",
"type": "number",
"tags": [],
"label": "y",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.i",
"type": "string",
"tags": [],
"label": "i",
"description": [],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
@ -3041,6 +2807,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData",
"type": "Type",
"tags": [],
"label": "GridData",
"description": [],
"signature": [
"{ w: number; h: number; x: number; y: number; i: string; }"
],
"path": "src/plugins/dashboard/common/embeddable/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.RawSavedDashboardPanel730ToLatest",

6
api_docs/dashboard.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import dashboardObj from './dashboard.json';
Adds the Dashboard app to Kibana
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 160 | 1 | 137 | 9 |
| 145 | 1 | 132 | 10 |
## Client

8
api_docs/dashboard_enhanced.json
View file

@ -607,7 +607,9 @@
"UrlGeneratorsSetup",
"; url: ",
"UrlService",
"; }"
"; navigate(options: ",
"RedirectOptions",
"): void; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
@ -702,7 +704,9 @@
"UrlGeneratorsStart",
"; url: ",
"UrlService",
"; }"
"; navigate(options: ",
"RedirectOptions",
"): void; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false

2
api_docs/dashboard_mode.mdx
View file

@ -12,7 +12,7 @@ import dashboardModeObj from './dashboard_mode.json';
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**

9277
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

2
api_docs/data.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Client

2
api_docs/data_autocomplete.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Client

4
api_docs/data_enhanced.mdx
View file

@ -10,9 +10,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import dataEnhancedObj from './data_enhanced.json';
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.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**

873
api_docs/data_index_patterns.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/data_index_patterns.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Server

160
api_docs/data_query.json
View file

@ -26,13 +26,7 @@
"text": "PersistableStateService"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
@ -488,13 +482,7 @@
"description": [],
"signature": [
"(filters: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
", collector: unknown) => {}"
],
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
@ -509,15 +497,7 @@
"label": "filters",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }"
"SerializableRecord"
],
"path": "src/plugins/data/common/query/persistable_state.ts",
"deprecated": false
@ -761,13 +741,9 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
"DslQuery",
"[]; filter: ",
"Filter",
"[]; should: never[]; must_not: ",
"Filter",
"[]; }; }; } | { filterManager: ",
" | undefined) => { bool: ",
"BoolQuery",
"; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
@ -876,13 +852,9 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
"DslQuery",
"[]; filter: ",
"Filter",
"[]; should: never[]; must_not: ",
"Filter",
"[]; }; }; } | { filterManager: ",
" | undefined) => { bool: ",
"BoolQuery",
"; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
@ -1418,13 +1390,9 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
"DslQuery",
"[]; filter: ",
"Filter",
"[]; should: never[]; must_not: ",
"Filter",
"[]; }; }; } | { filterManager: ",
" | undefined) => { bool: ",
"BoolQuery",
"; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
@ -1531,13 +1499,9 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
"DslQuery",
"[]; filter: ",
"Filter",
"[]; should: never[]; must_not: ",
"Filter",
"[]; }; }; } | { filterManager: ",
" | undefined) => { bool: ",
"BoolQuery",
"; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
@ -2035,27 +1999,6 @@
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.InputTimeRange",
"type": "Type",
"tags": [],
"label": "InputTimeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | { from: moment.Moment; to: moment.Moment; }"
],
"path": "src/plugins/data/public/query/timefilter/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryStart",
@ -2120,13 +2063,9 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
"DslQuery",
"[]; filter: ",
"Filter",
"[]; should: never[]; must_not: ",
"Filter",
"[]; }; }; }"
" | undefined) => { bool: ",
"BoolQuery",
"; }; }"
],
"path": "src/plugins/data/public/query/query_service.ts",
"deprecated": false,
@ -2204,13 +2143,7 @@
"text": "TimeRange"
},
"; setTime: (time: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.InputTimeRange",
"text": "InputTimeRange"
},
"InputTimeRange",
") => void; getRefreshInterval: () => ",
{
"pluginId": "data",
@ -2245,6 +2178,10 @@
},
" | undefined) => ",
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | ",
"MatchAllRangeFilter",
" | undefined; getBounds: () => ",
{
"pluginId": "data",
@ -2512,6 +2449,10 @@
},
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | ",
"MatchAllRangeFilter",
" | undefined"
],
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
@ -2672,39 +2613,6 @@
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval",
"type": "Interface",
"tags": [],
"label": "RefreshInterval",
"description": [],
"path": "src/plugins/data/common/query/timefilter/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval.pause",
"type": "boolean",
"tags": [],
"label": "pause",
"description": [],
"path": "src/plugins/data/common/query/timefilter/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"path": "src/plugins/data/common/query/timefilter/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRangeBounds",
@ -2747,6 +2655,20 @@
],
"enums": [],
"misc": [
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval",
"type": "Type",
"tags": [],
"label": "RefreshInterval",
"description": [],
"signature": [
"{ pause: boolean; value: number; }"
],
"path": "src/plugins/data/common/query/timefilter/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRange",

2
api_docs/data_query.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Client

1890
api_docs/data_search.json
View file

File diff suppressed because one or more lines are too long

8
api_docs/data_search.mdx
View file

@ -18,16 +18,13 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Client
### Functions
<DocDefinitionList data={dataSearchObj.client.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.client.interfaces}/>
@ -39,9 +36,6 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
## Server
### Functions
<DocDefinitionList data={dataSearchObj.server.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.server.classes}/>

25
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/data_ui.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3735 | 59 | 3217 | 52 |
| 3518 | 44 | 3001 | 50 |
## Client

4
api_docs/data_visualizer.json
View file

@ -542,7 +542,7 @@
"label": "type",
"description": [],
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\" | \"histogram\""
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\" | \"histogram\" | \"text\""
],
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"deprecated": false
@ -972,7 +972,7 @@
"label": "JobFieldType",
"description": [],
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\" | \"histogram\""
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\" | \"histogram\" | \"text\""
],
"path": "x-pack/plugins/data_visualizer/common/types/job_field_type.ts",
"deprecated": false,

204
api_docs/deprecations_by_api.mdx
View file

@ -8,48 +8,196 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
---
## Referenced deprecated APIs
| Deprecated API | Referencing plugin(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | discover, visualizations, dashboard, lens, observability, maps, dashboardEnhanced, discoverEnhanced, securitySolution | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.ExistsFilter" text="ExistsFilter"/> | observability | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.ExistsFilter" text="ExistsFilter"/> | observability | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | discover, visualizations, dashboard, lens, observability, maps, dashboardEnhanced, discoverEnhanced, securitySolution, visualize, timelion, 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.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, presentationUtil, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, presentationUtil, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, inputControlVis, visualize, visTypeTimelion, visTypeVega, presentationUtil, ml, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern.removeScriptedField" text="removeScriptedField"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern.getScriptedFields" text="getScriptedFields"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, indexPatternManagement, lens, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.getKbnTypeNames" text="getKbnTypeNames"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern.removeScriptedField" text="removeScriptedField"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern.getScriptedFields" text="getScriptedFields"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, indexPatternManagement, lens, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.getKbnTypeNames" text="getKbnTypeNames"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, indexPatternManagement, lens, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern.removeScriptedField" text="removeScriptedField"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern.getScriptedFields" text="getScriptedFields"/> | indexPatternManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.EsQueryConfig" text="EsQueryConfig"/> | visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.EsQueryConfig" text="EsQueryConfig"/> | visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.EsQueryConfig" text="EsQueryConfig"/> | visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldSubType" text="IFieldSubType"/> | timelines | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esKuery" text="esKuery"/> | fleet, lens, timelines, infra, dataVisualizer, ml, apm, securitySolution, stackAlerts, transform, uptime | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | lens, timelines, dataVisualizer, ml, infra, securitySolution, stackAlerts, transform | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldSubType" text="IFieldSubType"/> | timelines | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldSubType" text="IFieldSubType"/> | timelines | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, lens | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, lens | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | fleet, maps, ml, infra, stackAlerts, lens | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.KueryNode" text="KueryNode"/> | securitySolution, alerting, fleet, cases, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.MatchAllFilter" text="MatchAllFilter"/> | securitySolution | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.EsQueryConfig" text="EsQueryConfig"/> | securitySolution, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.MatchAllFilter" text="MatchAllFilter"/> | securitySolution | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.KueryNode" text="KueryNode"/> | securitySolution, alerting, fleet, cases, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.EsQueryConfig" text="EsQueryConfig"/> | securitySolution, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.EsQueryConfig" text="EsQueryConfig"/> | securitySolution, visTypeTimeseries | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.KueryNode" text="KueryNode"/> | securitySolution, alerting, fleet, cases, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.FilterMeta" text="FilterMeta"/> | lens | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esKuery" text="esKuery"/> | lens, infra, apm, stackAlerts, transform | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | discover, maps, inputControlVis | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | discover, maps, inputControlVis | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.AggConfig.toJSON" text="toJSON"/> | visualizations, visDefaultEditor | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.AggConfig.toJSON" text="toJSON"/> | visualizations, visDefaultEditor | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.ExistsFilter" text="ExistsFilter"/> | observability | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.ExistsFilter" text="ExistsFilter"/> | observability | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.isFilters" text="isFilters"/> | dashboardEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.isFilters" text="isFilters"/> | dashboardEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.RangeFilter" text="RangeFilter"/> | discoverEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.RangeFilter" text="RangeFilter"/> | discoverEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.KueryNode" text="KueryNode"/> | cases, alerting, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.nodeBuilder" text="nodeBuilder"/> | actions, alerting, cases, dataEnhanced | 8.1 |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | globalSearch | 7.16 |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - |
| <DocLink id="kibDataPluginApi" section="def-common.KueryNode" text="KueryNode"/> | cases, alerting, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.KueryNode" text="KueryNode"/> | cases, alerting, dataEnhanced | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.RangeFilterParams" text="RangeFilterParams"/> | visTypeTimelion | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.RangeFilterParams" text="RangeFilterParams"/> | visTypeTimelion | 8.1 |
| <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="kibDashboardPluginApi" section="def-public.DashboardStart.dashboardUrlGenerator" text="dashboardUrlGenerator"/> | securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | timelines, infra, ml, securitySolution, indexPatternManagement, stackAlerts, transform | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | timelines, infra, ml, securitySolution, indexPatternManagement, stackAlerts, transform | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | reporting, encryptedSavedObjects, actions, ml, dashboardMode, dataEnhanced, logstash, securitySolution | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | dashboard, lens, maps, ml, securitySolution, security, visualize | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | securitySolution | - |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | fleet | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectLoader" text="SavedObjectLoader"/> | visualizations, discover, dashboard, savedObjectsManagement | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | savedObjectsTaggingOss, visualizations, discover, dashboard, savedObjectsManagement | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | fleet, indexPatternFieldEditor, discover, dashboard, lens, ml, stackAlerts, indexPatternManagement, regionMap, tileMap, visTypeMetric, visTypeTable, visTypeTimeseries, visTypePie, visTypeXy, visTypeVislib | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, discover, presentationUtil, dashboard, graph | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, reporting, actions, alerting, ml, fleet, remoteClusters, graph, indexLifecycleManagement, maps, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, fleet, apm, reporting, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | - |
| <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="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | management, fleet, security, kibanaOverview, timelion | - |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | fleet | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.settings" text="settings"/> | dashboard, maps, visualize | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | lens, dashboard | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectLoader" text="SavedObjectLoader"/> | visualizations, discover, dashboard, savedObjectsManagement, timelion | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | discover, savedObjectsTaggingOss, visualizations, dashboard, visualize, visDefaultEditor, savedObjectsManagement | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | discover, visualizations, dashboard, timelion | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSourceFields.fieldsFromSource" text="fieldsFromSource"/> | reporting | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSourceFields.fieldsFromSource" text="fieldsFromSource"/> | reporting | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataPluginStart.fieldFormats" text="fieldFormats"/> | reporting | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | discover | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | discover | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, embeddable | - |
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas, regionMap, tileMap, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionFunctionDefinition.context" text="context"/> | canvas, regionMap, tileMap, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas, regionMap, tileMap, visTypeXy | - |
| <DocLink id="kibCorePluginApi" section="def-public.AsyncPlugin" text="AsyncPlugin"/> | visTypeTable | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Render" text="Render"/> | canvas, visTypePie, visTypeXy | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | encryptedSavedObjects, actions, alerting | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Render" text="Render"/> | canvas | - |
| <DocLink id="kibCorePluginApi" section="def-server.LegacyRequest" text="LegacyRequest"/> | security | - |
| <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | cloud, apm | - |
| <DocLink id="kibCorePluginApi" section="def-public.CoreSetup.injectedMetadata" text="injectedMetadata"/> | visTypeVega | - |
| <DocLink id="kibCorePluginApi" section="def-public.CoreStart.injectedMetadata" text="injectedMetadata"/> | monitoring, visTypeVega | - |
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverStart.urlGenerator" text="urlGenerator"/> | osquery | - |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | - |
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console | - |
## Unreferenced deprecated APIs
Safe to remove.
| Deprecated API |
| ---------------|
| <DocLink id="kibDashboardPluginApi" section="def-public.createDashboardUrlGenerator" text="createDashboardUrlGenerator"/> |
| <DocLink id="kibDashboardPluginApi" section="def-public.DashboardUrlGeneratorState" text="DashboardUrlGeneratorState"/> |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern.intervalName" text="intervalName"/> |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern.addScriptedField" text="addScriptedField"/> |
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternSpec.intervalName" text="intervalName"/> |
| <DocLink id="kibDataPluginApi" section="def-public.RangeFilterMeta" text="RangeFilterMeta"/> |
| <DocLink id="kibDataPluginApi" section="def-public.PhrasesFilter" text="PhrasesFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-public.PhraseFilter" text="PhraseFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-public.CustomFilter" text="CustomFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-public.MatchAllFilter" text="MatchAllFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-public.isFilter" text="isFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.COMPARE_ALL_OPTIONS" text="COMPARE_ALL_OPTIONS"/> |
| <DocLink id="kibDataPluginApi" section="def-common.compareFilters" text="compareFilters"/> |
| <DocLink id="kibDataPluginApi" section="def-common.enableFilter" text="enableFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.pinFilter" text="pinFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.toggleFilterDisabled" text="toggleFilterDisabled"/> |
| <DocLink id="kibDataPluginApi" section="def-common.disableFilter" text="disableFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.fromKueryExpression" text="fromKueryExpression"/> |
| <DocLink id="kibDataPluginApi" section="def-common.toElasticsearchQuery" text="toElasticsearchQuery"/> |
| <DocLink id="kibDataPluginApi" section="def-common.nodeTypes" text="nodeTypes"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildEsQuery" text="buildEsQuery"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildQueryFromFilters" text="buildQueryFromFilters"/> |
| <DocLink id="kibDataPluginApi" section="def-common.luceneStringToDsl" text="luceneStringToDsl"/> |
| <DocLink id="kibDataPluginApi" section="def-common.decorateQuery" text="decorateQuery"/> |
| <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterField" text="getPhraseFilterField"/> |
| <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterValue" text="getPhraseFilterValue"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isFilterPinned" text="isFilterPinned"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isExistsFilter" text="isExistsFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isMatchAllFilter" text="isMatchAllFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isMissingFilter" text="isMissingFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isPhraseFilter" text="isPhraseFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isPhrasesFilter" text="isPhrasesFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isRangeFilter" text="isRangeFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isQueryStringFilter" text="isQueryStringFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildQueryFilter" text="buildQueryFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildPhrasesFilter" text="buildPhrasesFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildPhraseFilter" text="buildPhraseFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildRangeFilter" text="buildRangeFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildCustomFilter" text="buildCustomFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildFilter" text="buildFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildEmptyFilter" text="buildEmptyFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.buildExistsFilter" text="buildExistsFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.toggleFilterNegated" text="toggleFilterNegated"/> |
| <DocLink id="kibDataPluginApi" section="def-common.FILTERS" text="FILTERS"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isFilter" text="isFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.isFilterDisabled" text="isFilterDisabled"/> |
| <DocLink id="kibDataPluginApi" section="def-common.dedupFilters" text="dedupFilters"/> |
| <DocLink id="kibDataPluginApi" section="def-common.onlyDisabledFiltersChanged" text="onlyDisabledFiltersChanged"/> |
| <DocLink id="kibDataPluginApi" section="def-common.uniqFilters" text="uniqFilters"/> |
| <DocLink id="kibDataPluginApi" section="def-common.RangeFilterMeta" text="RangeFilterMeta"/> |
| <DocLink id="kibDataPluginApi" section="def-common.PhrasesFilter" text="PhrasesFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.PhraseFilter" text="PhraseFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.MatchAllFilter" text="MatchAllFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.CustomFilter" text="CustomFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.MissingFilter" text="MissingFilter"/> |
| <DocLink id="kibDataPluginApi" section="def-common.FilterMeta" text="FilterMeta"/> |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern.intervalName" text="intervalName"/> |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern.addScriptedField" text="addScriptedField"/> |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternSpec.intervalName" text="intervalName"/> |
| <DocLink id="kibDataPluginApi" section="def-common.getKbnFieldType" text="getKbnFieldType"/> |
| <DocLink id="kibDataPluginApi" section="def-common.getFilterableKbnTypeNames" text="getFilterableKbnTypeNames"/> |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern.intervalName" text="intervalName"/> |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern.addScriptedField" text="addScriptedField"/> |
| <DocLink id="kibDataPluginApi" section="def-server.DataPluginSetup.fieldFormats" text="fieldFormats"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionExecutor" text="ExpressionExecutor"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.functions" text="functions"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.types" text="types"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-public.InterpreterErrorType" text="InterpreterErrorType"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-common.InterpreterErrorType" text="InterpreterErrorType"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.functions" text="functions"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.types" text="types"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.functions" text="functions"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.types" text="types"/> |
| <DocLink id="kibExpressionsPluginApi" section="def-server.InterpreterErrorType" text="InterpreterErrorType"/> |
| <DocLink id="kibCasesPluginApi" section="def-common.formatErrors" text="formatErrors"/> |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> |
| <DocLink id="kibLicensingPluginApi" section="def-public.ILicense.mode" text="mode"/> |
| <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"/> |
| <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.res" text="res"/> |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceStart.legacy" text="legacy"/> |
| <DocLink id="kibCorePluginApi" section="def-server.HttpServiceSetup.auth" text="auth"/> |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportFailure.title" text="title"/> |

1842
api_docs/deprecations_by_plugin.mdx
View file

File diff suppressed because it is too large Load diff

2
api_docs/dev_tools.mdx
View file

@ -12,7 +12,7 @@ import devToolsObj from './dev_tools.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**

35
api_docs/discover.json
View file

@ -77,13 +77,7 @@
"text": "DiscoverAppLocatorParams"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
}
"SerializableRecord"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false,
@ -159,13 +153,7 @@
"text": "RefreshInterval"
},
" & ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
") | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
@ -274,13 +262,7 @@
],
"signature": [
"(string[][] & ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
") | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
@ -1052,7 +1034,8 @@
"description": [],
"signature": [
"{ addDocView(docViewRaw: ComponentDocViewInput | ",
"RenderDocViewInput |",
"RenderDocViewInput",
" | ",
"DocViewInputFn",
"): void; }"
],
@ -1136,13 +1119,9 @@
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": true,
"references": [
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_discover_link.tsx"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/scheduled_query_groups/scheduled_query_group_queries_table.tsx"
"path": "x-pack/plugins/osquery/public/scheduled_query_groups/scheduled_query_group_queries_status_table.tsx"
},
{
"plugin": "osquery",
@ -1390,4 +1369,4 @@
],
"objects": []
}
}
}

303
api_docs/embeddable.json
View file

@ -1062,6 +1062,83 @@
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.Container.setChildLoaded",
"type": "Function",
"tags": [],
"label": "setChildLoaded",
"description": [],
"signature": [
"(embeddable: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
">) => void"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.Container.setChildLoaded.$1",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
">"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.Container.updateInputForChild",
@ -2103,6 +2180,16 @@
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.deferEmbeddableLoad",
"type": "boolean",
"tags": [],
"label": "deferEmbeddableLoad",
"description": [],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.type",
@ -2181,6 +2268,16 @@
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.destroyed",
"type": "boolean",
"tags": [],
"label": "destroyed",
"description": [],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.Unnamed",
@ -2587,6 +2684,23 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.setInitializationFinished",
"type": "Function",
"tags": [],
"label": "setInitializationFinished",
"description": [
"\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad."
],
"signature": [
"() => void"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.updateOutput",
@ -5684,6 +5798,19 @@
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableEditorState.originatingPath",
"type": "string",
"tags": [],
"label": "originatingPath",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableEditorState.embeddableId",
@ -6934,6 +7061,88 @@
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.IContainer.setChildLoaded",
"type": "Function",
"tags": [],
"label": "setChildLoaded",
"description": [
"\nEmbeddables which have deferEmbeddableLoad set to true need to manually call setChildLoaded\non their parent container to communicate when they have finished loading."
],
"signature": [
"<E extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
"> = ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
">>(embeddable: E) => void"
],
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.IContainer.setChildLoaded.$1",
"type": "Uncategorized",
"tags": [],
"label": "embeddable",
"description": [
"- the embeddable to set"
],
"signature": [
"E"
],
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.IContainer.removeEmbeddable",
@ -7165,6 +7374,18 @@
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.IEmbeddable.deferEmbeddableLoad",
"type": "boolean",
"tags": [],
"label": "deferEmbeddableLoad",
"description": [
"\nIf set to true, defer embeddable load tells the container that this embeddable\ntype isn't completely loaded when the constructor returns. This embeddable\nwill have to manually call setChildLoaded on its parent when all of its initial\noutput is finalized. For instance, after loading a saved object."
],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.IEmbeddable.runtimeId",
@ -8091,14 +8312,10 @@
"text": "ViewMode"
},
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }"
"SerializableRecord",
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ",
"KibanaExecutionContext",
" | undefined; }"
],
"path": "src/plugins/embeddable/common/types.ts",
"deprecated": false,
@ -8507,13 +8724,7 @@
"text": "EnhancementRegistryDefinition"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">) => void"
],
"path": "src/plugins/embeddable/public/plugin.tsx",
@ -8535,13 +8746,7 @@
"text": "EnhancementRegistryDefinition"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">"
],
"path": "src/plugins/embeddable/public/plugin.tsx",
@ -9190,13 +9395,7 @@
"text": "EnhancementRegistryDefinition"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">) => void"
],
"path": "src/plugins/embeddable/server/plugin.ts",
@ -9218,13 +9417,7 @@
"text": "EnhancementRegistryDefinition"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">"
],
"path": "src/plugins/embeddable/server/plugin.ts",
@ -9961,14 +10154,10 @@
"text": "ViewMode"
},
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }"
"SerializableRecord",
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ",
"KibanaExecutionContext",
" | undefined; }"
],
"path": "src/plugins/embeddable/common/types.ts",
"deprecated": false,
@ -10033,21 +10222,9 @@
"description": [],
"signature": [
"(state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
", version: string) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
}
"SerializableRecord"
],
"path": "src/plugins/embeddable/common/lib/migrate.ts",
"deprecated": false,
@ -10061,15 +10238,7 @@
"label": "state",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }"
"SerializableRecord"
],
"path": "src/plugins/embeddable/common/lib/migrate.ts",
"deprecated": false

4
api_docs/embeddable.mdx
View file

@ -12,13 +12,13 @@ import embeddableObj from './embeddable.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 460 | 5 | 388 | 3 |
| 469 | 5 | 393 | 3 |
## Client

2
api_docs/embeddable_enhanced.mdx
View file

@ -12,7 +12,7 @@ import embeddableEnhancedObj from './embeddable_enhanced.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**

222
api_docs/es_ui_shared.json
View file

@ -258,6 +258,51 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditor",
"type": "Function",
"tags": [],
"label": "EuiCodeEditor",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "esUiShared",
"scope": "public",
"docId": "kibEsUiSharedPluginApi",
"section": "def-public.EuiCodeEditorProps",
"text": "EuiCodeEditorProps"
},
") => JSX.Element"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditor.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "esUiShared",
"scope": "public",
"docId": "kibEsUiSharedPluginApi",
"section": "def-public.EuiCodeEditorProps",
"text": "EuiCodeEditorProps"
}
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.extractQueryParams",
@ -736,6 +781,183 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps",
"type": "Interface",
"tags": [],
"label": "EuiCodeEditorProps",
"description": [],
"signature": [
{
"pluginId": "esUiShared",
"scope": "public",
"docId": "kibEsUiSharedPluginApi",
"section": "def-public.EuiCodeEditorProps",
"text": "EuiCodeEditorProps"
},
" extends Pick<React.AriaAttributes, SupportedAriaAttribute>,Pick<",
"IAceEditorProps",
", \"onChange\" | \"name\" | \"defaultValue\" | \"className\" | \"placeholder\" | \"style\" | \"onCopy\" | \"onPaste\" | \"onFocus\" | \"onBlur\" | \"onInput\" | \"onLoad\" | \"onScroll\" | \"value\" | \"height\" | \"width\" | \"fontSize\" | \"theme\" | \"showGutter\" | \"showPrintMargin\" | \"highlightActiveLine\" | \"focus\" | \"cursorStart\" | \"wrapEnabled\" | \"readOnly\" | \"minLines\" | \"maxLines\" | \"navigateToFileEnd\" | \"debounceChangePeriod\" | \"enableBasicAutocompletion\" | \"enableLiveAutocompletion\" | \"tabSize\" | \"scrollMargin\" | \"enableSnippets\" | \"onSelectionChange\" | \"onCursorChange\" | \"onValidate\" | \"onBeforeLoad\" | \"onSelection\" | \"editorProps\" | \"setOptions\" | \"keyboardHandler\" | \"commands\" | \"annotations\" | \"markers\">"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.width",
"type": "string",
"tags": [],
"label": "width",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.height",
"type": "string",
"tags": [],
"label": "height",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.onBlur",
"type": "Function",
"tags": [],
"label": "onBlur",
"description": [],
"signature": [
"((event: any, editor?: ",
"AceEditorClass",
" | undefined) => void) | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.onFocus",
"type": "Function",
"tags": [],
"label": "onFocus",
"description": [],
"signature": [
"((event: any, editor?: ",
"AceEditorClass",
" | undefined) => void) | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.isReadOnly",
"type": "CompoundType",
"tags": [],
"label": "isReadOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.setOptions",
"type": "Object",
"tags": [],
"label": "setOptions",
"description": [],
"signature": [
"IAceOptions",
" | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.cursorStart",
"type": "number",
"tags": [],
"label": "cursorStart",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.theme",
"type": "string",
"tags": [],
"label": "theme",
"description": [
"\nSelect the `brace` theme\nThe matching theme file must also be imported from `brace` (e.g., `import 'brace/theme/github';`)"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.mode",
"type": "CompoundType",
"tags": [],
"label": "mode",
"description": [
"\nUse string for a built-in mode or object for a custom mode"
],
"signature": [
"string | object | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.EuiCodeEditorProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "esUiShared",
"id": "def-public.JsonEditorState",

4
api_docs/es_ui_shared.mdx
View file

@ -12,13 +12,13 @@ import esUiSharedObj from './es_ui_shared.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 92 | 5 | 90 | 1 |
| 106 | 5 | 102 | 1 |
## Client

22
api_docs/event_log.json
View file

@ -579,7 +579,7 @@
"label": "logEvent",
"description": [],
"signature": [
"(properties: DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -592,7 +592,7 @@
"label": "properties",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -609,7 +609,7 @@
"label": "startTiming",
"description": [],
"signature": [
"(event: DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -622,7 +622,7 @@
"label": "event",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -639,7 +639,7 @@
"label": "stopTiming",
"description": [],
"signature": [
"(event: DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -652,7 +652,7 @@
"label": "event",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,
@ -712,7 +712,7 @@
"label": "data",
"description": [],
"signature": [
"(Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
"(Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false
@ -731,7 +731,7 @@
"label": "IEvent",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,
@ -745,7 +745,7 @@
"label": "IValidatedEvent",
"description": [],
"signature": [
"Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
"Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,
@ -979,7 +979,7 @@
"label": "getLogger",
"description": [],
"signature": [
"(properties: DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
{
"pluginId": "eventLog",
"scope": "server",
@ -999,7 +999,7 @@
"label": "properties",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; timezone?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false,

2
api_docs/event_log.mdx
View file

@ -12,7 +12,7 @@ import eventLogObj from './event_log.json';
Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) for questions regarding this plugin.
**Code health stats**

4
api_docs/expression_error.mdx
View file

@ -10,9 +10,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionErrorObj from './expression_error.json';
Adds 'error' renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**

312
api_docs/expression_image.json
View file

@ -20,7 +20,13 @@
"text": "ExpressionRenderDefinition"
},
"<",
"ImageRendererConfig",
{
"pluginId": "expressionImage",
"scope": "common",
"docId": "kibExpressionImagePluginApi",
"section": "def-common.ImageRendererConfig",
"text": "ImageRendererConfig"
},
">"
],
"path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx",
@ -50,7 +56,13 @@
"text": "ExpressionRenderDefinition"
},
"<",
"ImageRendererConfig",
{
"pluginId": "expressionImage",
"scope": "common",
"docId": "kibExpressionImagePluginApi",
"section": "def-common.ImageRendererConfig",
"text": "ImageRendererConfig"
},
">)[]"
],
"path": "src/plugins/expression_image/public/expression_renderers/index.ts",
@ -81,14 +93,302 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"parentPluginId": "expressionImage",
"id": "def-server.ExpressionImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_image/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"interfaces": [
{
"parentPluginId": "expressionImage",
"id": "def-common.ImageRendererConfig",
"type": "Interface",
"tags": [],
"label": "ImageRendererConfig",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionImage",
"id": "def-common.ImageRendererConfig.dataurl",
"type": "CompoundType",
"tags": [],
"label": "dataurl",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.ImageRendererConfig.mode",
"type": "CompoundType",
"tags": [],
"label": "mode",
"description": [],
"signature": [
{
"pluginId": "expressionImage",
"scope": "common",
"docId": "kibExpressionImagePluginApi",
"section": "def-common.ImageMode",
"text": "ImageMode"
},
" | null"
],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.NodeDimensions",
"type": "Interface",
"tags": [],
"label": "NodeDimensions",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionImage",
"id": "def-common.NodeDimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.NodeDimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.Return",
"type": "Interface",
"tags": [],
"label": "Return",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionImage",
"id": "def-common.Return.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"image\""
],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.Return.mode",
"type": "string",
"tags": [],
"label": "mode",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.Return.dataurl",
"type": "string",
"tags": [],
"label": "dataurl",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "expressionImage",
"id": "def-common.ImageMode",
"type": "Enum",
"tags": [],
"label": "ImageMode",
"description": [],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "expressionImage",
"id": "def-common.BASE64",
"type": "string",
"tags": [],
"label": "BASE64",
"description": [],
"signature": [
"\"`base64`\""
],
"path": "src/plugins/expression_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.CONTEXT",
"type": "string",
"tags": [],
"label": "CONTEXT",
"description": [],
"signature": [
"\"_context_\""
],
"path": "src/plugins/expression_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.ExpressionImageFunction",
"type": "Type",
"tags": [],
"label": "ExpressionImageFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"image\", null, Arguments, Promise<",
{
"pluginId": "expressionImage",
"scope": "common",
"docId": "kibExpressionImagePluginApi",
"section": "def-common.Return",
"text": "Return"
},
">, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_image/common/types/expression_functions.ts",
"deprecated": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.OriginString",
"type": "Type",
"tags": [],
"label": "OriginString",
"description": [],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\""
],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionImage\""
],
"path": "src/plugins/expression_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionImage\""
],
"path": "src/plugins/expression_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionImage",
"id": "def-common.URL",
"type": "string",
"tags": [],
"label": "URL",
"description": [],
"signature": [
"\"URL\""
],
"path": "src/plugins/expression_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

22
api_docs/expression_image.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionImageObj from './expression_image.json';
Adds 'image' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 1 |
| 24 | 0 | 24 | 0 |
## Client
@ -31,3 +31,19 @@ import expressionImageObj from './expression_image.json';
### Consts, variables and types
<DocDefinitionList data={expressionImageObj.client.misc}/>
## Server
### Start
<DocDefinitionList data={[expressionImageObj.server.start]}/>
## Common
### Interfaces
<DocDefinitionList data={expressionImageObj.common.interfaces}/>
### Enums
<DocDefinitionList data={expressionImageObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={expressionImageObj.common.misc}/>

465
api_docs/expression_metric.json
View file

@ -20,7 +20,13 @@
"text": "ExpressionRenderDefinition"
},
"<",
"MetricRendererConfig",
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.MetricRendererConfig",
"text": "MetricRendererConfig"
},
">"
],
"path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx",
@ -50,7 +56,13 @@
"text": "ExpressionRenderDefinition"
},
"<",
"MetricRendererConfig",
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.MetricRendererConfig",
"text": "MetricRendererConfig"
},
">)[]"
],
"path": "src/plugins/expression_metric/public/expression_renderers/index.ts",
@ -81,14 +93,455 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"parentPluginId": "expressionMetric",
"id": "def-server.ExpressionMetricPluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionMetricPluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_metric/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"functions": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.metricFunction",
"type": "Function",
"tags": [],
"label": "metricFunction",
"description": [],
"signature": [
"() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"string\" | \"null\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: string | number | null, { label, labelFont, metricFont, metricFormat }: ",
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.Arguments",
"text": "Arguments"
},
") => { type: \"render\"; as: string; value: { metric: React.ReactText; label: string; labelFont: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
},
"; metricFont: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
},
"; metricFormat: string; }; }; }"
],
"path": "src/plugins/expression_metric/common/expression_functions/metric_function.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.Arguments",
"type": "Interface",
"tags": [],
"label": "Arguments",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.Arguments.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.Arguments.metricFont",
"type": "Object",
"tags": [],
"label": "metricFont",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
}
],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.Arguments.metricFormat",
"type": "string",
"tags": [],
"label": "metricFormat",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.Arguments.labelFont",
"type": "Object",
"tags": [],
"label": "labelFont",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
}
],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig",
"type": "Interface",
"tags": [],
"label": "MetricRendererConfig",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig.label",
"type": "string",
"tags": [],
"label": "label",
"description": [
"The text to display under the metric"
],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig.labelFont",
"type": "Object",
"tags": [],
"label": "labelFont",
"description": [
"Font settings for the label"
],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
}
],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig.metric",
"type": "CompoundType",
"tags": [],
"label": "metric",
"description": [
"Value of the metric to display"
],
"signature": [
"string | number | null"
],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig.metricFont",
"type": "Object",
"tags": [],
"label": "metricFont",
"description": [
"Font settings for the metric"
],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
}
],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.MetricRendererConfig.metricFormat",
"type": "string",
"tags": [],
"label": "metricFormat",
"description": [
"NumeralJS format string"
],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.NodeDimensions",
"type": "Interface",
"tags": [],
"label": "NodeDimensions",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.NodeDimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.NodeDimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"path": "src/plugins/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "expressionMetric",
"id": "def-common.CSS",
"type": "string",
"tags": [],
"label": "CSS",
"description": [],
"signature": [
"\"CSS\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.ExpressionMetricFunction",
"type": "Type",
"tags": [],
"label": "ExpressionMetricFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"metric\", string | number | null, ",
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.Arguments",
"text": "Arguments"
},
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"render\", { as: string; value: ",
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.Arguments",
"text": "Arguments"
},
"; }>, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.FONT_FAMILY",
"type": "string",
"tags": [],
"label": "FONT_FAMILY",
"description": [],
"signature": [
"\"`font-family`\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.FONT_WEIGHT",
"type": "string",
"tags": [],
"label": "FONT_WEIGHT",
"description": [],
"signature": [
"\"`font-weight`\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.functions",
"type": "Array",
"tags": [],
"label": "functions",
"description": [],
"signature": [
{
"pluginId": "expressionMetric",
"scope": "common",
"docId": "kibExpressionMetricPluginApi",
"section": "def-common.ExpressionMetricFunction",
"text": "ExpressionMetricFunction"
},
"[]"
],
"path": "src/plugins/expression_metric/common/expression_functions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.Input",
"type": "Type",
"tags": [],
"label": "Input",
"description": [],
"signature": [
"string | number | null"
],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.NUMERALJS",
"type": "string",
"tags": [],
"label": "NUMERALJS",
"description": [],
"signature": [
"\"Numeral pattern\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionMetric\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetric",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionMetric\""
],
"path": "src/plugins/expression_metric/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

22
api_docs/expression_metric.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionMetricObj from './expression_metric.json';
Adds 'metric' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 1 |
| 30 | 0 | 25 | 0 |
## Client
@ -31,3 +31,19 @@ import expressionMetricObj from './expression_metric.json';
### Consts, variables and types
<DocDefinitionList data={expressionMetricObj.client.misc}/>
## Server
### Start
<DocDefinitionList data={[expressionMetricObj.server.start]}/>
## Common
### Functions
<DocDefinitionList data={expressionMetricObj.common.functions}/>
### Interfaces
<DocDefinitionList data={expressionMetricObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={expressionMetricObj.common.misc}/>

19
api_docs/expression_repeat_image.json
View file

@ -93,7 +93,22 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"parentPluginId": "expressionRepeatImage",
"id": "def-server.ExpressionRepeatImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRepeatImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_repeat_image/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
@ -350,7 +365,7 @@
"text": "Adapters"
},
", ",
"Serializable",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",

11
api_docs/expression_repeat_image.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionRepeatImageObj from './expression_repeat_image.json';
Adds 'repeatImage' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 28 | 0 | 28 | 0 |
| 30 | 0 | 30 | 0 |
## Client
@ -31,6 +31,11 @@ import expressionRepeatImageObj from './expression_repeat_image.json';
### Consts, variables and types
<DocDefinitionList data={expressionRepeatImageObj.client.misc}/>
## Server
### Start
<DocDefinitionList data={[expressionRepeatImageObj.server.start]}/>
## Common
### Functions

114
api_docs/expression_reveal_image.json
View file

@ -81,14 +81,122 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"parentPluginId": "expressionRevealImage",
"id": "def-server.ExpressionRevealImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRevealImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_reveal_image/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"functions": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.revealImageFunction",
"type": "Function",
"tags": [],
"label": "revealImageFunction",
"description": [],
"signature": [
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
"Origin",
"[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
"Origin",
"; percent: number; }; }>; }"
],
"path": "src/plugins/expression_reveal_image/common/expression_functions/reveal_image_function.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.BASE64",
"type": "string",
"tags": [],
"label": "BASE64",
"description": [],
"signature": [
"\"`base64`\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.functions",
"type": "Array",
"tags": [],
"label": "functions",
"description": [],
"signature": [
"ExpressionRevealImageFunction",
"[]"
],
"path": "src/plugins/expression_reveal_image/common/expression_functions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionRevealImage\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionRevealImage\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.URL",
"type": "string",
"tags": [],
"label": "URL",
"description": [],
"signature": [
"\"URL\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

19
api_docs/expression_reveal_image.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionRevealImageObj from './expression_reveal_image.json';
Adds 'revealImage' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 1 |
| 12 | 0 | 12 | 3 |
## Client
@ -31,3 +31,16 @@ import expressionRevealImageObj from './expression_reveal_image.json';
### Consts, variables and types
<DocDefinitionList data={expressionRevealImageObj.client.misc}/>
## Server
### Start
<DocDefinitionList data={[expressionRevealImageObj.server.start]}/>
## Common
### Functions
<DocDefinitionList data={expressionRevealImageObj.common.functions}/>
### Consts, variables and types
<DocDefinitionList data={expressionRevealImageObj.common.misc}/>

25
api_docs/expression_shape.json
View file

@ -1320,7 +1320,7 @@
"text": "Adapters"
},
", ",
"SerializableState",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -1370,7 +1370,7 @@
"text": "Adapters"
},
", ",
"Serializable",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -1915,7 +1915,22 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"parentPluginId": "expressionShape",
"id": "def-server.ExpressionShapePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionShapePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_shape/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
@ -2446,7 +2461,7 @@
"text": "Adapters"
},
", ",
"SerializableState",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -2496,7 +2511,7 @@
"text": "Adapters"
},
", ",
"Serializable",
"SerializableRecord",
">>"
],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",

11
api_docs/expression_shape.mdx
View file

@ -10,15 +10,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
---
import expressionShapeObj from './expression_shape.json';
Adds 'shape' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 141 | 0 | 141 | 0 |
| 143 | 0 | 143 | 0 |
## Client
@ -37,6 +37,11 @@ import expressionShapeObj from './expression_shape.json';
### Consts, variables and types
<DocDefinitionList data={expressionShapeObj.client.misc}/>
## Server
### Start
<DocDefinitionList data={[expressionShapeObj.server.start]}/>
## Common
### Functions

85
api_docs/expression_tagcloud.json Normal file
View file

@ -0,0 +1,85 @@
{
"id": "expressionTagcloud",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "expressionTagcloud",
"id": "def-public.ExpressionTagcloudPluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionTagcloudPluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/chart_expressions/expression_tagcloud/public/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionTagcloud",
"id": "def-common.EXPRESSION_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_NAME",
"description": [],
"signature": [
"\"tagcloud\""
],
"path": "src/plugins/chart_expressions/expression_tagcloud/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionTagcloud",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionTagcloud\""
],
"path": "src/plugins/chart_expressions/expression_tagcloud/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionTagcloud",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionTagcloud\""
],
"path": "src/plugins/chart_expressions/expression_tagcloud/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

32
api_docs/expression_tagcloud.mdx Normal file
View file

@ -0,0 +1,32 @@
---
id: kibExpressionTagcloudPluginApi
slug: /kibana-dev-docs/expressionTagcloudPluginApi
title: expressionTagcloud
image: https://source.unsplash.com/400x175/?github
summary: API docs for the expressionTagcloud plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
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 expressionTagcloudObj from './expression_tagcloud.json';
Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart.
Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 5 | 0 | 5 | 0 |
## Client
### Start
<DocDefinitionList data={[expressionTagcloudObj.client.start]}/>
## Common
### Consts, variables and types
<DocDefinitionList data={expressionTagcloudObj.common.misc}/>

706
api_docs/expressions.json
View file

File diff suppressed because it is too large Load diff

4
api_docs/expressions.mdx
View file

@ -12,13 +12,13 @@ import expressionsObj from './expressions.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2030 | 65 | 1595 | 5 |
| 2032 | 65 | 1597 | 4 |
## Client

2
api_docs/features.mdx
View file

@ -12,7 +12,7 @@ import featuresObj from './features.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**

85
api_docs/field_formats.json
View file

@ -1739,83 +1739,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatNotFoundError",
"type": "Class",
"tags": [],
"label": "FieldFormatNotFoundError",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatNotFoundError",
"text": "FieldFormatNotFoundError"
},
" extends Error"
],
"path": "src/plugins/field_formats/common/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatNotFoundError.formatId",
"type": "string",
"tags": [],
"label": "formatId",
"description": [],
"path": "src/plugins/field_formats/common/errors.ts",
"deprecated": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatNotFoundError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatNotFoundError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/field_formats/common/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatNotFoundError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "formatId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/field_formats/common/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormatsRegistry",
@ -4231,7 +4154,7 @@
"label": "FieldFormatsContentType",
"description": [],
"signature": [
"\"html\" | \"text\""
"\"text\" | \"html\""
],
"path": "src/plugins/field_formats/common/types.ts",
"deprecated": false,
@ -4244,7 +4167,7 @@
"tags": [],
"label": "FieldFormatsGetConfigFn",
"description": [
"\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible."
"\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible.\n"
],
"signature": [
"<T = any>(key: string, defaultOverride?: T | undefined) => T"
@ -4435,7 +4358,7 @@
"label": "HTML_CONTEXT_TYPE",
"description": [],
"signature": [
"\"html\" | \"text\""
"\"text\" | \"html\""
],
"path": "src/plugins/field_formats/common/content_types/html_content_type.ts",
"deprecated": false,
@ -4577,7 +4500,7 @@
"label": "TEXT_CONTEXT_TYPE",
"description": [],
"signature": [
"\"html\" | \"text\""
"\"text\" | \"html\""
],
"path": "src/plugins/field_formats/common/content_types/text_content_type.ts",
"deprecated": false,

2
api_docs/field_formats.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 268 | 26 | 238 | 10 |
| 263 | 26 | 233 | 10 |
## Client

13
api_docs/file_upload.json
View file

@ -1380,6 +1380,19 @@
"path": "x-pack/plugins/file_upload/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.ImportFailure.caused_by",
"type": "Object",
"tags": [],
"label": "caused_by",
"description": [],
"signature": [
"{ type: string; reason: string; } | undefined"
],
"path": "x-pack/plugins/file_upload/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.ImportFailure.doc",

2
api_docs/file_upload.mdx
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 |
|-------------------|-----------|------------------------|-----------------|
| 128 | 4 | 128 | 1 |
| 129 | 4 | 129 | 1 |
## Client

492
api_docs/fleet.json
View file

@ -2084,6 +2084,38 @@
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.upgrade_package_policy",
"type": "Function",
"tags": [],
"label": "upgrade_package_policy",
"description": [],
"signature": [
"({ policyId, packagePolicyId }: ",
"DynamicPagePathValues",
") => [string, string]"
],
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.upgrade_package_policy.$1",
"type": "Object",
"tags": [],
"label": "{ policyId, packagePolicyId }",
"description": [],
"signature": [
"DynamicPagePathValues"
],
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.agent_list",
@ -4292,7 +4324,7 @@
"signature": [
"Pick<",
"KibanaClient",
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"helpers\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"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\" | \"monitoring\" | \"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: ",
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"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\" | \"monitoring\" | \"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: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
@ -4468,6 +4500,80 @@
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.getAgentStatusForAgentPolicy",
"type": "Function",
"tags": [],
"label": "getAgentStatusForAgentPolicy",
"description": [
"\nReturn the status by the Agent's Policy id"
],
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", agentPolicyId?: string | undefined, filterKuery?: string | undefined) => Promise<{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }>"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.getAgentStatusForAgentPolicy.$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.getAgentStatusForAgentPolicy.$2",
"type": "string",
"tags": [],
"label": "agentPolicyId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.getAgentStatusForAgentPolicy.$3",
"type": "string",
"tags": [],
"label": "filterKuery",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/fleet/server/services/index.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-server.AgentService.listAgents",
@ -4510,7 +4616,7 @@
"signature": [
"Pick<",
"KibanaClient",
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"helpers\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"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\" | \"monitoring\" | \"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: ",
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"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\" | \"monitoring\" | \"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: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
@ -5126,73 +5232,13 @@
"\nCallbacks supported by the Fleet plugin"
],
"signature": [
"[\"packagePolicyCreate\", (newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", 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.NewPackagePolicy",
"text": "NewPackagePolicy"
},
">] | [\"packagePolicyUpdate\", (newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
},
", context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", 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.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
},
">]"
"ExternalCallbackCreate",
" | ",
"ExternalCallbackDelete",
" | ",
"ExternalCallbackUpdate"
],
"path": "x-pack/plugins/fleet/server/plugin.ts",
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false,
"initialIsOpen": false
},
@ -5223,6 +5269,269 @@
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PostPackagePolicyCreateCallback",
"type": "Type",
"tags": [],
"label": "PostPackagePolicyCreateCallback",
"description": [],
"signature": [
"(newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", 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.NewPackagePolicy",
"text": "NewPackagePolicy"
},
">"
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.newPackagePolicy",
"type": "Object",
"tags": [],
"label": "newPackagePolicy",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-server.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
}
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-server.request",
"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/types/extensions.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PostPackagePolicyDeleteCallback",
"type": "Type",
"tags": [],
"label": "PostPackagePolicyDeleteCallback",
"description": [],
"signature": [
"(deletedPackagePolicies: ",
"_DeepReadonlyArray",
"<{ id: string; name?: string | undefined; success: boolean; package?: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined; }>) => Promise<void>"
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.deletedPackagePolicies",
"type": "Object",
"tags": [],
"label": "deletedPackagePolicies",
"description": [],
"signature": [
"_DeepReadonlyArray",
"<{ id: string; name?: string | undefined; success: boolean; package?: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined; }>"
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PutPackagePolicyUpdateCallback",
"type": "Type",
"tags": [],
"label": "PutPackagePolicyUpdateCallback",
"description": [],
"signature": [
"(updatePackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
},
", context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", 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.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
},
">"
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.updatePackagePolicy",
"type": "Object",
"tags": [],
"label": "updatePackagePolicy",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
}
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-server.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
}
],
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-server.request",
"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/types/extensions.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"objects": [
@ -5874,7 +6183,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
"SavedObject",
"<",
{
@ -5892,7 +6201,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })) => boolean"
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })) => boolean"
],
"path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts",
"deprecated": false,
@ -6008,7 +6317,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
"SavedObject",
"<",
{
@ -6026,7 +6335,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })"
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })"
],
"path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts",
"deprecated": false,
@ -14554,7 +14863,7 @@
"label": "[RegistryVarsEntryKeys.type]",
"description": [],
"signature": [
"\"string\" | \"text\" | \"password\" | \"yaml\" | \"integer\" | \"bool\""
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\""
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false
@ -15862,7 +16171,15 @@
"label": "DeletePackagePoliciesResponse",
"description": [],
"signature": [
"{ id: string; name?: string | undefined; success: boolean; }[]"
"{ id: string; name?: string | undefined; success: boolean; package?: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined; }[]"
],
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"deprecated": false,
@ -15911,7 +16228,7 @@
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
" & { errors?: { key: string | undefined; message: string; }[] | undefined; }"
" & { errors?: { key: string | undefined; message: string; }[] | undefined; missingVars?: string[] | undefined; }"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
@ -16895,7 +17212,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
"SavedObject",
"<",
{
@ -16913,7 +17230,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })"
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
@ -17272,7 +17589,7 @@
"label": "RegistrySearchResult",
"description": [],
"signature": [
"{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; download: string; path: string; internal?: boolean | undefined; data_streams?: ",
"{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; internal?: boolean | undefined; data_streams?: ",
{
"pluginId": "fleet",
"scope": "common",
@ -17326,7 +17643,7 @@
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">[]"
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">[]"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
@ -17340,7 +17657,7 @@
"label": "RegistryVarType",
"description": [],
"signature": [
"\"string\" | \"text\" | \"password\" | \"yaml\" | \"integer\" | \"bool\""
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\""
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
@ -19716,6 +20033,21 @@
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.packagePolicyRouteService.getUpgradePath",
"type": "Function",
"tags": [],
"label": "getUpgradePath",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false

4
api_docs/fleet.mdx
View file

@ -12,13 +12,13 @@ import fleetObj from './fleet.json';
Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1149 | 15 | 1049 | 8 |
| 1166 | 15 | 1065 | 11 |
## Client

10
api_docs/global_search.json
View file

@ -627,15 +627,7 @@
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; }; elasticsearch: { legacy: { client: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.LegacyScopedClusterClient",
"text": "LegacyScopedClusterClient"
},
", \"callAsCurrentUser\" | \"callAsInternalUser\">; }; }; uiSettings: { client: ",
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; }; uiSettings: { client: ",
{
"pluginId": "core",
"scope": "server",

2
api_docs/global_search.mdx
View file

@ -12,7 +12,7 @@ import globalSearchObj from './global_search.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**

41
api_docs/home.json
View file

@ -297,18 +297,6 @@
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
},
{
"parentPluginId": "home",
"id": "def-public.FeatureCatalogueSolution.subtitle",
"type": "string",
"tags": [],
"label": "subtitle",
"description": [
"The tagline of the solution displayed to the user."
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
},
{
"parentPluginId": "home",
"id": "def-public.FeatureCatalogueSolution.description",
@ -318,24 +306,6 @@
"description": [
"One-line description of the solution displayed to the user."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
},
{
"parentPluginId": "home",
"id": "def-public.FeatureCatalogueSolution.appDescriptions",
"type": "Array",
"tags": [],
"label": "appDescriptions",
"description": [
"A list of use cases for this solution displayed to the user."
],
"signature": [
"string[]"
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
},
@ -375,9 +345,6 @@
"description": [
"An ordinal used to sort solutions relative to one another for display on the home page"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
}
@ -978,7 +945,7 @@
"label": "InstructionSetSchema",
"description": [],
"signature": [
"{ readonly title?: string | undefined; readonly callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }"
"{ readonly title?: string | undefined; readonly callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -992,7 +959,7 @@
"label": "InstructionsSchema",
"description": [],
"signature": [
"{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }"
"{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -1054,7 +1021,7 @@
"signature": [
"(context: ",
"TutorialContext",
") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; isBeta?: boolean | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; } & { id: string; name: string; category: \"metrics\" | \"security\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; isBeta?: boolean | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; } & { id: string; name: string; category: \"metrics\" | \"security\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
"deprecated": false,
@ -1084,7 +1051,7 @@
"label": "TutorialSchema",
"description": [],
"signature": [
"{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly isBeta?: boolean | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly id: string; readonly name: string; readonly category: \"metrics\" | \"security\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
"{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly isBeta?: boolean | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly id: string; readonly name: string; readonly category: \"metrics\" | \"security\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,

4
api_docs/home.mdx
View file

@ -12,13 +12,13 @@ import homeObj from './home.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 101 | 3 | 77 | 5 |
| 99 | 3 | 77 | 5 |
## Client

8
api_docs/index_lifecycle_management.json
View file

@ -20,13 +20,7 @@
"text": "IlmLocatorParams"
},
" extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
}
"SerializableRecord"
],
"path": "x-pack/plugins/index_lifecycle_management/public/locator.ts",
"deprecated": false,

2
api_docs/index_lifecycle_management.mdx
View file

@ -12,7 +12,7 @@ import indexLifecycleManagementObj from './index_lifecycle_management.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**

2
api_docs/index_management.mdx
View file

@ -12,7 +12,7 @@ import indexManagementObj from './index_management.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**

257
api_docs/index_pattern_editor.json Normal file
View file

@ -0,0 +1,257 @@
{
"id": "indexPatternEditor",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps",
"type": "Interface",
"tags": [],
"label": "IndexPatternEditorProps",
"description": [],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [
"\nHandler for the \"save\" footer button"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => void"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onSave.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [
"- newly created index pattern"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onCancel",
"type": "Function",
"tags": [],
"label": "onCancel",
"description": [
"\nHandler for the \"cancel\" footer button"
],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.defaultTypeIsRollup",
"type": "CompoundType",
"tags": [],
"label": "defaultTypeIsRollup",
"description": [
"\nSets the default index pattern type to rollup. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.requireTimestampField",
"type": "CompoundType",
"tags": [],
"label": "requireTimestampField",
"description": [
"\nSets whether a timestamp field is required to create an index pattern. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart",
"type": "Interface",
"tags": [],
"label": "PluginStart",
"description": [],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.openEditor",
"type": "Function",
"tags": [],
"label": "openEditor",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
},
") => () => void"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.openEditor.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
}
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.IndexPatternEditorComponent",
"type": "Function",
"tags": [],
"label": "IndexPatternEditorComponent",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
},
">"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.props",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.context",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.userPermissions",
"type": "Object",
"tags": [],
"label": "userPermissions",
"description": [],
"signature": [
"{ editIndexPattern: () => boolean; }"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/index_pattern_editor.mdx Normal file
View file

@ -0,0 +1,30 @@
---
id: kibIndexPatternEditorPluginApi
slug: /kibana-dev-docs/indexPatternEditorPluginApi
title: indexPatternEditor
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexPatternEditor plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternEditor']
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 indexPatternEditorObj from './index_pattern_editor.json';
This plugin provides the ability to create index patterns via a modal flyout from any kibana app
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 13 | 1 | 8 | 0 |
## Client
### Start
<DocDefinitionList data={[indexPatternEditorObj.client.start]}/>
### Interfaces
<DocDefinitionList data={indexPatternEditorObj.client.interfaces}/>

103
api_docs/index_pattern_field_editor.json
View file

@ -170,74 +170,6 @@
],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext",
"type": "Interface",
"tags": [],
"label": "FieldEditorContext",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.indexPattern",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.fieldTypeToProcess",
"type": "CompoundType",
"tags": [],
"label": "fieldTypeToProcess",
"description": [
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
],
"signature": [
"\"concrete\" | \"runtime\""
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.search",
"type": "Object",
"tags": [],
"label": "search",
"description": [
"The search service from the data plugin"
],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataSearchPluginApi",
"section": "def-public.ISearchStart",
"text": "ISearchStart"
}
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps",
@ -606,6 +538,41 @@
}
],
"objects": [],
"setup": {
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginSetup",
"type": "Interface",
"tags": [],
"label": "PluginSetup",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginSetup.fieldFormatEditors",
"type": "Object",
"tags": [],
"label": "fieldFormatEditors",
"description": [],
"signature": [
"{ register: (editor: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FieldFormatEditorFactory",
"text": "FieldFormatEditorFactory"
},
"<any>) => void; }"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart",

5
api_docs/index_pattern_field_editor.mdx
View file

@ -18,10 +18,13 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 44 | 2 | 39 | 3 |
| 42 | 2 | 39 | 3 |
## Client
### Setup
<DocDefinitionList data={[indexPatternFieldEditorObj.client.setup]}/>
### Start
<DocDefinitionList data={[indexPatternFieldEditorObj.client.start]}/>

53
api_docs/index_pattern_management.json Normal file
View file

@ -0,0 +1,53 @@
{
"id": "indexPatternManagement",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "indexPatternManagement",
"id": "def-public.IndexPatternManagementSetup",
"type": "Interface",
"tags": [],
"label": "IndexPatternManagementSetup",
"description": [],
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "indexPatternManagement",
"id": "def-public.IndexPatternManagementStart",
"type": "Interface",
"tags": [],
"label": "IndexPatternManagementStart",
"description": [],
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/index_pattern_management.mdx Normal file
View file

@ -0,0 +1,30 @@
---
id: kibIndexPatternManagementPluginApi
slug: /kibana-dev-docs/indexPatternManagementPluginApi
title: indexPatternManagement
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexPatternManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternManagement']
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 indexPatternManagementObj from './index_pattern_management.json';
Index pattern management app
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2 | 0 | 2 | 0 |
## Client
### Setup
<DocDefinitionList data={[indexPatternManagementObj.client.setup]}/>
### Start
<DocDefinitionList data={[indexPatternManagementObj.client.start]}/>

2
api_docs/inspector.mdx
View file

@ -12,7 +12,7 @@ import inspectorObj from './inspector.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**

110
api_docs/kibana_overview.json Normal file
View file

@ -0,0 +1,110 @@
{
"id": "kibanaOverview",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "kibanaOverview",
"id": "def-public.KibanaOverviewPluginSetup",
"type": "Interface",
"tags": [],
"label": "KibanaOverviewPluginSetup",
"description": [],
"path": "src/plugins/kibana_overview/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "kibanaOverview",
"id": "def-public.KibanaOverviewPluginStart",
"type": "Interface",
"tags": [],
"label": "KibanaOverviewPluginStart",
"description": [],
"path": "src/plugins/kibana_overview/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "kibanaOverview",
"id": "def-common.PLUGIN_ICON",
"type": "string",
"tags": [],
"label": "PLUGIN_ICON",
"description": [],
"signature": [
"\"logoKibana\""
],
"path": "src/plugins/kibana_overview/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaOverview",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"kibanaOverview\""
],
"path": "src/plugins/kibana_overview/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaOverview",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"Overview\""
],
"path": "src/plugins/kibana_overview/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaOverview",
"id": "def-common.PLUGIN_PATH",
"type": "string",
"tags": [],
"label": "PLUGIN_PATH",
"description": [],
"signature": [
"\"/app/kibana_overview\""
],
"path": "src/plugins/kibana_overview/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

35
api_docs/kibana_overview.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibKibanaOverviewPluginApi
slug: /kibana-dev-docs/kibanaOverviewPluginApi
title: kibanaOverview
image: https://source.unsplash.com/400x175/?github
summary: API docs for the kibanaOverview plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview']
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 kibanaOverviewObj from './kibana_overview.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 6 | 0 | 6 | 0 |
## Client
### Setup
<DocDefinitionList data={[kibanaOverviewObj.client.setup]}/>
### Start
<DocDefinitionList data={[kibanaOverviewObj.client.start]}/>
## Common
### Consts, variables and types
<DocDefinitionList data={kibanaOverviewObj.common.misc}/>

2107
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

4
api_docs/kibana_react.mdx
View file

@ -12,13 +12,13 @@ import kibanaReactObj from './kibana_react.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 270 | 8 | 240 | 4 |
| 299 | 8 | 262 | 5 |
## Client

134
api_docs/kibana_utils.json
View file

@ -9146,13 +9146,7 @@
"text": "VersionedState"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">) => S"
],
"path": "src/plugins/kibana_utils/common/persistable_state/migrate_to_latest.ts",
@ -9194,13 +9188,7 @@
"text": "VersionedState"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">"
],
"path": "src/plugins/kibana_utils/common/persistable_state/migrate_to_latest.ts",
@ -10003,13 +9991,7 @@
"text": "VersionedState"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">) => P) | undefined"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
@ -10033,13 +10015,7 @@
"text": "VersionedState"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
">"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
@ -10960,21 +10936,9 @@
],
"signature": [
"(state: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
", version: string) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
}
"SerializableRecord"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false,
@ -10988,15 +10952,7 @@
"label": "state",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }"
"SerializableRecord"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false
@ -11203,82 +11159,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.Serializable",
"type": "Type",
"tags": [],
"label": "Serializable",
"description": [],
"signature": [
"string | number | boolean | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"[] | null | undefined"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.Serializable",
"type": "Type",
"tags": [],
"label": "Serializable",
"description": [
"\nSerializable state is something is a POJO JavaScript object that can be\nserialized to a JSON string."
],
"signature": [
"{ [key: string]: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.SerializableRecord",
"type": "Type",
"tags": [],
"label": "SerializableRecord",
"description": [],
"signature": [
"string | number | boolean | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | null | undefined"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaUtils",
"id": "def-common.Set",

4
api_docs/kibana_utils.mdx
View file

@ -12,13 +12,13 @@ import kibanaUtilsObj from './kibana_utils.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 600 | 3 | 406 | 8 |
| 597 | 3 | 404 | 8 |
## Client

706
api_docs/lens.json
View file

@ -126,6 +126,19 @@
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
],
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.sorting",
@ -535,6 +548,36 @@
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/legend_config.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.maxLines",
"type": "number",
"tags": [],
"label": "maxLines",
"description": [
"\nMaximum number of lines per legend item"
],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/legend_config.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.shouldTruncate",
"type": "CompoundType",
"tags": [],
"label": "shouldTruncate",
"description": [
"\nFlag whether the legend items are truncated or not"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/legend_config.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -616,14 +659,10 @@
],
"signature": [
"(input: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
", openInNewTab?: boolean | undefined) => void"
"LensByValueInput",
" | ",
"LensByReferenceInput",
" | undefined, options?: { openInNewTab?: boolean | undefined; originatingApp?: string | undefined; originatingPath?: string | undefined; } | undefined) => void"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
@ -636,31 +675,65 @@
"label": "input",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
}
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2",
"type": "CompoundType",
"tags": [],
"label": "openInNewTab",
"description": [],
"signature": [
"boolean | undefined"
"LensByValueInput",
" | ",
"LensByReferenceInput",
" | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.options.openInNewTab",
"type": "CompoundType",
"tags": [],
"label": "openInNewTab",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.options.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.options.originatingPath",
"type": "string",
"tags": [],
"label": "originatingPath",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false
}
]
}
],
"returnComment": []
@ -792,6 +865,19 @@
],
"path": "x-pack/plugins/lens/common/expressions/metric_chart/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
],
"path": "x-pack/plugins/lens/common/expressions/metric_chart/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -921,7 +1007,7 @@
"label": "shape",
"description": [],
"signature": [
"\"donut\" | \"pie\" | \"treemap\""
"\"pie\" | \"donut\" | \"treemap\""
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false
@ -1136,6 +1222,32 @@
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendMaxLines",
"type": "number",
"tags": [],
"label": "legendMaxLines",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.truncateLegend",
"type": "CompoundType",
"tags": [],
"label": "truncateLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -1314,6 +1426,19 @@
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/layer_config.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
],
"path": "x-pack/plugins/lens/common/expressions/xy_chart/layer_config.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -1375,7 +1500,7 @@
"label": "fittingFunction",
"description": [],
"signature": [
"\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined"
"\"None\" | \"Linear\" | \"Zero\" | \"Carry\" | \"Lookahead\" | undefined"
],
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"deprecated": false
@ -1745,7 +1870,7 @@
"signature": [
"(Pick<",
"LensByValueInput",
", \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { attributes: LensAttributes<\"lnsXY\", ",
", \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"executionContext\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { attributes: LensAttributes<\"lnsXY\", ",
{
"pluginId": "lens",
"scope": "public",
@ -2147,7 +2272,15 @@
"description": [],
"signature": [
"SharedPieLayerState",
" & { layerId: string; }"
" & { layerId: string; layerType: ",
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.LayerType",
"text": "LayerType"
},
"; }"
],
"path": "x-pack/plugins/lens/common/expressions/pie_chart/types.ts",
"deprecated": false,
@ -2202,7 +2335,7 @@
"signature": [
"Pick<",
"LensByValueInput",
", \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { attributes: LensAttributes<\"lnsXY\", ",
", \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"executionContext\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { attributes: LensAttributes<\"lnsXY\", ",
{
"pluginId": "lens",
"scope": "public",
@ -2298,7 +2431,15 @@
"section": "def-server.Plugin",
"text": "Plugin"
},
"<{}, {}, {}, {}>"
"<",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensServerPluginSetup",
"text": "LensServerPluginSetup"
},
", {}, {}, {}>"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
@ -2372,7 +2513,23 @@
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
},
") => {}"
") => { lensEmbeddableFactory: () => ",
{
"pluginId": "embeddable",
"scope": "server",
"docId": "kibEmbeddablePluginApi",
"section": "def-server.EmbeddableRegistryDefinition",
"text": "EmbeddableRegistryDefinition"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
">; }"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
@ -2522,6 +2679,242 @@
],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715",
"type": "Interface",
"tags": [],
"label": "LensDocShape715",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShape715",
"text": "LensDocShape715"
},
"<VisualizationState>"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.visualizationType",
"type": "CompoundType",
"tags": [],
"label": "visualizationType",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record<string, { columnOrder: string[]; columns: Record<string, Record<string, unknown>>; }>; }; }; visualization: VisualizationState; query: ",
"Query",
"; filters: ",
"Filter",
"[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePost712",
"type": "Interface",
"tags": [],
"label": "LensDocShapePost712",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShapePost712",
"text": "LensDocShapePost712"
},
"<VisualizationState>"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePost712.visualizationType",
"type": "CompoundType",
"tags": [],
"label": "visualizationType",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePost712.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePost712.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePost712.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record<string, { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }>; }; }; visualization: VisualizationState; query: ",
"Query",
"; filters: ",
"Filter",
"[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePre712",
"type": "Interface",
"tags": [],
"label": "LensDocShapePre712",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShapePre712",
"text": "LensDocShapePre712"
},
"<VisualizationState>"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePre712.visualizationType",
"type": "CompoundType",
"tags": [],
"label": "visualizationType",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePre712.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePre712.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShapePre712.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"{ datasourceStates: { indexpattern: { layers: Record<string, { columns: Record<string, { operationType: ",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.OperationTypePre712",
"text": "OperationTypePre712"
},
"; }>; }>; }; }; query: ",
"Query",
"; visualization: VisualizationState; filters: ",
"Filter",
"[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract",
@ -2738,13 +3131,7 @@
"text": "ErrorLike"
},
"; info?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"SerializableRecord",
" | undefined; }> | Output>>; readonly fork: () => ",
{
"pluginId": "expressions",
@ -2791,6 +3178,25 @@
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginStartContract.fieldFormats",
"type": "Object",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "server",
"docId": "kibFieldFormatsPluginApi",
"section": "def-server.FieldFormatsStart",
"text": "FieldFormatsStart"
}
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginStartContract.data",
@ -2815,8 +3221,162 @@
}
],
"enums": [],
"misc": [],
"objects": []
"misc": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape713",
"type": "Type",
"tags": [],
"label": "LensDocShape713",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShapePost712",
"text": "LensDocShapePost712"
},
"<unknown>, \"title\" | \"expression\" | \"visualizationType\"> & { state: Pick<{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record<string, { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }>; }; }; visualization: unknown; query: ",
"Query",
"; filters: ",
"Filter",
"[]; }, \"filters\" | \"query\" | \"visualization\" | \"datasourceMetaData\"> & { datasourceStates: { indexpattern: Pick<{ currentIndexPatternId: string; layers: Record<string, { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }>; }, \"currentIndexPatternId\"> & { layers: Record<string, Pick<{ columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }, never> & { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; } | { operationType: \"date_histogram\"; params: { interval: string; timeZone?: string | undefined; }; }>; }>; }; }; }; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape714",
"type": "Type",
"tags": [],
"label": "LensDocShape714",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShapePost712",
"text": "LensDocShapePost712"
},
"<unknown>, \"title\" | \"expression\" | \"visualizationType\"> & { state: Pick<{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record<string, { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }>; }; }; visualization: unknown; query: ",
"Query",
"; filters: ",
"Filter",
"[]; }, \"filters\" | \"query\" | \"visualization\" | \"datasourceMetaData\"> & { datasourceStates: { indexpattern: Pick<{ currentIndexPatternId: string; layers: Record<string, { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }>; }, \"currentIndexPatternId\"> & { layers: Record<string, Pick<{ columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; }>; }, never> & { columns: Record<string, { operationType: \"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"; } | { operationType: \"date_histogram\"; params: { interval: string; }; }>; }>; }; }; }; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.OperationTypePost712",
"type": "Type",
"tags": [],
"label": "OperationTypePost712",
"description": [],
"signature": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\""
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.OperationTypePre712",
"type": "Type",
"tags": [],
"label": "OperationTypePre712",
"description": [],
"signature": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"percentile\" | \"terms\" | \"avg\" | \"median\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"cardinality\" | \"counter_rate\" | \"last_value\""
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.VisStatePost715",
"type": "Type",
"tags": [],
"label": "VisStatePost715",
"description": [],
"signature": [
"LayerPost715 | { layers: LayerPost715[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.VisStatePre715",
"type": "Type",
"tags": [],
"label": "VisStatePre715",
"description": [],
"signature": [
"LayerPre715 | { layers: LayerPre715[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "LensServerPluginSetup",
"description": [],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup.lensEmbeddableFactory",
"type": "Function",
"tags": [],
"label": "lensEmbeddableFactory",
"description": [],
"signature": [
"() => ",
{
"pluginId": "embeddable",
"scope": "server",
"docId": "kibEmbeddablePluginApi",
"section": "def-server.EmbeddableRegistryDefinition",
"text": "EmbeddableRegistryDefinition"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
">"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"returnComment": [],
"children": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
@ -3670,6 +4230,20 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.LayerType",
"type": "Type",
"tags": [],
"label": "LayerType",
"description": [],
"signature": [
"\"data\" | \"threshold\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.LENS_EDIT_BY_VALUE",
@ -3757,6 +4331,46 @@
"initialIsOpen": false
}
],
"objects": []
"objects": [
{
"parentPluginId": "lens",
"id": "def-common.layerTypes",
"type": "Object",
"tags": [],
"label": "layerTypes",
"description": [],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.layerTypes.DATA",
"type": "string",
"tags": [],
"label": "DATA",
"description": [],
"signature": [
"\"data\""
],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.layerTypes.THRESHOLD",
"type": "string",
"tags": [],
"label": "THRESHOLD",
"description": [],
"signature": [
"\"threshold\""
],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}

11
api_docs/lens.mdx
View file

@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 208 | 0 | 192 | 23 |
| 246 | 0 | 228 | 23 |
## Client
@ -30,14 +30,23 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
## Server
### Setup
<DocDefinitionList data={[lensObj.server.setup]}/>
### Classes
<DocDefinitionList data={lensObj.server.classes}/>
### Interfaces
<DocDefinitionList data={lensObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={lensObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={lensObj.common.objects}/>
### Functions
<DocDefinitionList data={lensObj.common.functions}/>

2
api_docs/license_api_guard.mdx
View file

@ -12,7 +12,7 @@ import licenseApiGuardObj from './license_api_guard.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin.
**Code health stats**

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