github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity

Clean up task manager public setup contract to improve readability and API docs (#113415) (#113543)

Browse source 
* Improve API docs for task manager

* Update docs
This commit is contained in:
Stacey Gammon 2021-09-30 13:13:54 -04:00 • committed by GitHub
parent 9e1c88443f
commit 2fd5d20ec4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 709 additions and 460 deletions
Download patch file Download diff file Expand all files Collapse all files

50
api_docs/apm.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/apm.mdx
View file

@ -18,7 +18,7 @@ Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions reg
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 42 | 0 | 42 | 36 |
| 42 | 0 | 42 | 37 |
## Client

2
api_docs/core.mdx
View file

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

2
api_docs/core_application.mdx
View file

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

2
api_docs/core_chrome.mdx
View file

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

2
api_docs/core_http.mdx
View file

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

15
api_docs/core_saved_objects.json
View file

@ -14902,6 +14902,21 @@
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [
"\nWhen specified, will be used instead of the type's name in SO management section's labels."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.visibleInManagement",

2
api_docs/core_saved_objects.mdx
View file

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

54
api_docs/custom_integrations.json
View file

@ -179,7 +179,14 @@
"label": "icons",
"description": [],
"signature": [
"{ src: string; type: string; }[]"
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegrationIcon",
"text": "CustomIntegrationIcon"
},
"[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -447,7 +454,14 @@
"label": "icons",
"description": [],
"signature": [
"{ src: string; type: string; }[]"
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegrationIcon",
"text": "CustomIntegrationIcon"
},
"[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -477,6 +491,42 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationIcon",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon.src",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"eui\" | \"svg\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],

2
api_docs/custom_integrations.mdx
View file

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

12
api_docs/data.json
View file

@ -16126,10 +16126,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/navigation/helpers.ts"
@ -33469,10 +33465,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/navigation/helpers.ts"
@ -40231,10 +40223,6 @@
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/helpers.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/navigation/helpers.ts"

1
api_docs/deprecations_by_api.mdx
View file

@ -86,6 +86,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas, regionMap, tileMap, visTypeXy | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | encryptedSavedObjects, actions, alerting | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console | - |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesPluginSetup.spacesService" text="spacesService"/> | security, reporting, apm, infra, securitySolution | 7.16 |
| <DocLink id="kibSpacesPluginApi" section="def-server.SpacesServiceSetup.getSpaceId" text="getSpaceId"/> | security, reporting, apm, infra, securitySolution | 7.16 |

7
api_docs/deprecations_by_plugin.mdx
View file

@ -18,6 +18,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibSecurityPluginApi" section="def-server.LegacyAuditLogger" text="LegacyAuditLogger"/> | [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger), [audit_logger.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/authorization/audit_logger.ts#:~:text=LegacyAuditLogger) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authc) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authz) | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - |
@ -801,14 +802,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - |
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters)+ 15 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | [expandable_network.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/expandable_network.tsx#:~:text=esQuery), [expandable_network.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/expandable_network.tsx#:~:text=esQuery), [events_viewer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx#:~:text=esQuery), [events_viewer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/top_n/index.tsx#:~:text=esQuery)+ 30 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 164 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 164 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 163 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 163 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternField" text="IndexPatternField"/> | [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern)+ 76 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternField" text="IndexPatternField"/> | [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern)+ 10 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 164 more | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 163 more | 8.1 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |

2
api_docs/discover_enhanced.json
View file

@ -723,7 +723,7 @@
"signature": [
"{ dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"
],
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"deprecated": false

41
api_docs/fleet.json
View file

@ -5018,7 +5018,13 @@
"description": [],
"signature": [
"(options?: ",
"ListArtifactsProps",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ListArtifactsProps",
"text": "ListArtifactsProps"
},
" | undefined) => Promise<",
{
"pluginId": "fleet",
@ -5048,7 +5054,13 @@
"label": "options",
"description": [],
"signature": [
"ListArtifactsProps",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ListArtifactsProps",
"text": "ListArtifactsProps"
},
" | undefined"
],
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
@ -5454,6 +5466,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-server.ListArtifactsProps",
"type": "Type",
"tags": [],
"label": "ListArtifactsProps",
"description": [],
"signature": [
"Pick<Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}>, \"page\" | \"perPage\" | \"sortOrder\" | \"kuery\"> & { sortField?: string | undefined; }"
],
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyServiceInterface",
@ -12304,6 +12330,15 @@
"label": "icons",
"description": [],
"signature": [
"(",
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegrationIcon",
"text": "CustomIntegrationIcon"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
@ -12311,7 +12346,7 @@
"section": "def-common.PackageSpecIcon",
"text": "PackageSpecIcon"
},
"[]"
")[]"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false

2
api_docs/fleet.mdx
View file

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

26
api_docs/home.json
View file

@ -973,17 +973,9 @@
"label": "SampleDataRegistrySetup",
"description": [],
"signature": [
"{ registerSampleDataset: (specProvider: ",
{
"pluginId": "home",
"scope": "server",
"docId": "kibHomePluginApi",
"section": "def-server.SampleDatasetProvider",
"text": "SampleDatasetProvider"
},
") => void; getSampleDatasets: () => ",
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
"SampleDatasetDashboardPanel",
@ -1003,7 +995,7 @@
"signature": [
"() => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
],
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
"deprecated": false,
@ -1302,17 +1294,9 @@
"label": "sampleData",
"description": [],
"signature": [
"{ registerSampleDataset: (specProvider: ",
{
"pluginId": "home",
"scope": "server",
"docId": "kibHomePluginApi",
"section": "def-server.SampleDatasetProvider",
"text": "SampleDatasetProvider"
},
") => void; getSampleDatasets: () => ",
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
"SampleDatasetDashboardPanel",

56
api_docs/index_management.json
View file

@ -168,12 +168,12 @@
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.documents",
"type": "Any",
"type": "string",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"any"
"string | undefined"
],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
@ -201,6 +201,16 @@
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.aliases",
@ -421,12 +431,12 @@
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.documents",
"type": "Any",
"type": "string",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"any"
"string | undefined"
],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
@ -454,6 +464,16 @@
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.aliases",
@ -1474,12 +1494,12 @@
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.documents",
"type": "Any",
"type": "string",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"any"
"string | undefined"
],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
@ -1507,6 +1527,16 @@
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.aliases",
@ -2286,6 +2316,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.MAJOR_VERSION",
"type": "string",
"tags": [],
"label": "MAJOR_VERSION",
"description": [],
"signature": [
"\"7.16.0\""
],
"path": "x-pack/plugins/index_management/common/constants/plugin.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateType",

2
api_docs/index_management.mdx
View file

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

354
api_docs/kibana_legacy.json
View file

@ -67,7 +67,7 @@
},
"<{}, { dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}"
],
"path": "src/plugins/kibana_legacy/public/plugin.ts",
"deprecated": false,
@ -89,7 +89,7 @@
},
"<{}, { dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>"
],
"path": "src/plugins/kibana_legacy/public/plugin.ts",
"deprecated": false,
@ -116,7 +116,7 @@
},
") => { dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
],
"path": "src/plugins/kibana_legacy/public/plugin.ts",
"deprecated": false,
@ -180,94 +180,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.addFatalError",
"type": "Function",
"tags": [],
"label": "addFatalError",
"description": [],
"signature": [
"(fatalErrors: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.FatalErrorsSetup",
"text": "FatalErrorsSetup"
},
", error: string | Error | ",
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.AngularHttpError",
"text": "AngularHttpError"
},
", location: string | undefined) => void"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.addFatalError.$1",
"type": "Object",
"tags": [],
"label": "fatalErrors",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.FatalErrorsSetup",
"text": "FatalErrorsSetup"
}
],
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.addFatalError.$2",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | Error | ",
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.AngularHttpError",
"text": "AngularHttpError"
}
],
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.addFatalError.$3",
"type": "string",
"tags": [],
"label": "location",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.configureAppAngularModule",
@ -548,37 +460,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.formatStack",
"type": "Function",
"tags": [],
"label": "formatStack",
"description": [],
"signature": [
"(err: Record<string, any>) => any"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.formatStack.$1",
"type": "Object",
"tags": [],
"label": "err",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.isAngularHttpError",
@ -641,67 +522,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PaginateControlsDirectiveProvider",
"type": "Function",
"tags": [],
"label": "PaginateControlsDirectiveProvider",
"description": [],
"signature": [
"() => any"
],
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PaginateDirectiveProvider",
"type": "Function",
"tags": [],
"label": "PaginateDirectiveProvider",
"description": [],
"signature": [
"($parse: any, $compile: any) => any"
],
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PaginateDirectiveProvider.$1",
"type": "Any",
"tags": [],
"label": "$parse",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PaginateDirectiveProvider.$2",
"type": "Any",
"tags": [],
"label": "$compile",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.PrivateProvider",
@ -717,158 +537,6 @@
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.registerListenEventListener",
"type": "Function",
"tags": [],
"label": "registerListenEventListener",
"description": [],
"signature": [
"($rootScope: unknown) => void"
],
"path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.registerListenEventListener.$1",
"type": "Unknown",
"tags": [],
"label": "$rootScope",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.subscribeWithScope",
"type": "Function",
"tags": [],
"label": "subscribeWithScope",
"description": [
"\nSubscribe to an observable at a $scope, ensuring that the digest cycle\nis run for subscriber hooks and routing errors to fatalError if not handled."
],
"signature": [
"($scope: angular.IScope, observable: ",
"Observable",
"<T>, observer: ",
"NextObserver",
"<T> | ",
"ErrorObserver",
"<T> | ",
"CompletionObserver",
"<T> | undefined, fatalError: FatalErrorFn | undefined) => ",
"Subscription"
],
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.subscribeWithScope.$1",
"type": "Object",
"tags": [],
"label": "$scope",
"description": [],
"signature": [
"angular.IScope"
],
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.subscribeWithScope.$2",
"type": "Object",
"tags": [],
"label": "observable",
"description": [],
"signature": [
"Observable",
"<T>"
],
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.subscribeWithScope.$3",
"type": "CompoundType",
"tags": [],
"label": "observer",
"description": [],
"signature": [
"NextObserver",
"<T> | ",
"ErrorObserver",
"<T> | ",
"CompletionObserver",
"<T> | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.subscribeWithScope.$4",
"type": "Function",
"tags": [],
"label": "fatalError",
"description": [],
"signature": [
"FatalErrorFn | undefined"
],
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.watchMultiDecorator",
"type": "Function",
"tags": [],
"label": "watchMultiDecorator",
"description": [],
"signature": [
"($provide: unknown) => void"
],
"path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.watchMultiDecorator.$1",
"type": "Unknown",
"tags": [],
"label": "$provide",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
@ -1128,20 +796,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.KbnAccessibleClickProvider",
"type": "CompoundType",
"tags": [],
"label": "KbnAccessibleClickProvider",
"description": [],
"signature": [
"angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController> | (string | angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>)[]"
],
"path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaLegacy",
"id": "def-public.KibanaLegacySetup",
@ -1166,7 +820,7 @@
"signature": [
"{ dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
],
"path": "src/plugins/kibana_legacy/public/plugin.ts",
"deprecated": false,

2
api_docs/kibana_legacy.mdx
View file

@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 70 | 3 | 66 | 1 |
| 50 | 1 | 47 | 1 |
## Client

2
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/lens.json
View file

@ -3002,7 +3002,7 @@
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract.taskManager",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "taskManager",
"description": [],

28
api_docs/observability.json
View file

@ -4155,6 +4155,34 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "observability",
"id": "def-common.enableInspectEsQueries",
"type": "string",
"tags": [],
"label": "enableInspectEsQueries",
"description": [],
"signature": [
"\"observability:enableInspectEsQueries\""
],
"path": "x-pack/plugins/observability/common/ui_settings_keys.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "observability",
"id": "def-common.maxSuggestions",
"type": "string",
"tags": [],
"label": "maxSuggestions",
"description": [],
"signature": [
"\"observability:maxSuggestions\""
],
"path": "x-pack/plugins/observability/common/ui_settings_keys.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "observability",
"id": "def-common.observabilityAppId",

2
api_docs/observability.mdx
View file

@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 232 | 0 | 232 | 10 |
| 234 | 0 | 234 | 10 |
## Client

20
api_docs/plugin_directory.mdx
View file

@ -18,7 +18,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------|
| 20178 | 272 | 16278 | 604 |
| 20191 | 267 | 16280 | 603 |
## Plugin Directory
@ -27,7 +27,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibActionsPluginApi" text="actions"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 125 | 0 | 125 | 8 |
| <DocLink id="kibAdvancedSettingsPluginApi" text="advancedSettings"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 23 | 0 | 22 | 1 |
| <DocLink id="kibAlertingPluginApi" text="alerting"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 248 | 0 | 240 | 16 |
| <DocLink id="kibApmPluginApi" text="apm"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | - | 42 | 0 | 42 | 36 |
| <DocLink id="kibApmPluginApi" text="apm"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | - | 42 | 0 | 42 | 37 |
| <DocLink id="kibApmOssPluginApi" text="apmOss"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | - | 6 | 0 | 6 | 0 |
| <DocLink id="kibBannersPluginApi" text="banners"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 |
| <DocLink id="kibBfetchPluginApi" text="bfetch"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 77 | 1 | 66 | 2 |
@ -37,9 +37,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibCloudPluginApi" text="cloud"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 22 | 0 | 22 | 0 |
| code | [Kibana Operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibConsolePluginApi" text="console"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 9 | 0 | 9 | 1 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2294 | 27 | 1021 | 30 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2295 | 27 | 1021 | 30 |
| crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 66 | 0 | 66 | 0 |
| <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 69 | 0 | 69 | 0 |
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 145 | 1 | 132 | 10 |
| <DocLink id="kibDashboardEnhancedPluginApi" text="dashboardEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 51 | 0 | 50 | 0 |
| <DocLink id="kibDashboardModePluginApi" text="dashboardMode"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 11 | 0 | 11 | 0 |
@ -66,7 +66,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibFeaturesPluginApi" text="features"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 216 | 0 | 98 | 2 |
| <DocLink id="kibFieldFormatsPluginApi" text="fieldFormats"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 288 | 7 | 250 | 3 |
| <DocLink id="kibFileUploadPluginApi" text="fileUpload"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 129 | 4 | 129 | 1 |
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1196 | 15 | 1095 | 11 |
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1197 | 15 | 1096 | 10 |
| <DocLink id="kibGlobalSearchPluginApi" text="globalSearch"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 |
| globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
| globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
@ -74,7 +74,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| grokdebugger | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibHomePluginApi" text="home"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 99 | 3 | 77 | 5 |
| <DocLink id="kibIndexLifecycleManagementPluginApi" text="indexLifecycleManagement"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 |
| <DocLink id="kibIndexManagementPluginApi" text="indexManagement"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 165 | 12 | 160 | 3 |
| <DocLink id="kibIndexManagementPluginApi" text="indexManagement"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 169 | 9 | 164 | 3 |
| <DocLink id="kibIndexPatternEditorPluginApi" text="indexPatternEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create index patterns via a modal flyout from any kibana app | 13 | 1 | 8 | 0 |
| <DocLink id="kibIndexPatternFieldEditorPluginApi" text="indexPatternFieldEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable index pattern field editor across Kibana | 42 | 2 | 39 | 3 |
| <DocLink id="kibIndexPatternManagementPluginApi" text="indexPatternManagement"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern management app | 2 | 0 | 2 | 0 |
@ -82,7 +82,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| ingestPipelines | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| inputControlVis | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 |
| <DocLink id="kibInspectorPluginApi" text="inspector"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 6 | 96 | 4 |
| <DocLink id="kibKibanaLegacyPluginApi" text="kibanaLegacy"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 70 | 3 | 66 | 1 |
| <DocLink id="kibKibanaLegacyPluginApi" text="kibanaLegacy"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 50 | 1 | 47 | 1 |
| <DocLink id="kibKibanaOverviewPluginApi" text="kibanaOverview"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 |
| <DocLink id="kibKibanaReactPluginApi" text="kibanaReact"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 297 | 8 | 260 | 5 |
| kibanaUsageCollection | [Kibana Telemtry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 |
@ -102,7 +102,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibMonitoringPluginApi" text="monitoring"/> | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 10 | 0 | 10 | 2 |
| <DocLink id="kibNavigationPluginApi" text="navigation"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 31 | 0 | 31 | 2 |
| <DocLink id="kibNewsfeedPluginApi" text="newsfeed"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 |
| <DocLink id="kibObservabilityPluginApi" text="observability"/> | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 232 | 0 | 232 | 10 |
| <DocLink id="kibObservabilityPluginApi" text="observability"/> | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 234 | 0 | 234 | 10 |
| <DocLink id="kibOsqueryPluginApi" text="osquery"/> | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 11 | 0 | 11 | 0 |
| painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibPresentationUtilPluginApi" text="presentationUtil"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 178 | 3 | 151 | 5 |
@ -113,7 +113,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibRuleRegistryPluginApi" text="ruleRegistry"/> | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 132 | 0 | 109 | 7 |
| <DocLink id="kibRuntimeFieldsPluginApi" text="runtimeFields"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 |
| <DocLink id="kibSavedObjectsPluginApi" text="savedObjects"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 221 | 3 | 207 | 4 |
| <DocLink id="kibSavedObjectsManagementPluginApi" text="savedObjectsManagement"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 106 | 0 | 93 | 0 |
| <DocLink id="kibSavedObjectsManagementPluginApi" text="savedObjectsManagement"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 111 | 0 | 98 | 0 |
| <DocLink id="kibSavedObjectsTaggingPluginApi" text="savedObjectsTagging"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 54 | 0 | 50 | 0 |
| <DocLink id="kibSavedObjectsTaggingOssPluginApi" text="savedObjectsTaggingOss"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 3 | 51 | 0 |
| <DocLink id="kibScreenshotModePluginApi" text="screenshotMode"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 22 | 0 | 17 | 1 |
@ -125,7 +125,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibSnapshotRestorePluginApi" text="snapshotRestore"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 23 | 1 | 22 | 1 |
| <DocLink id="kibSpacesPluginApi" text="spaces"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 203 | 0 | 20 | 1 |
| <DocLink id="kibStackAlertsPluginApi" text="stackAlerts"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 4 | 0 | 4 | 0 |
| <DocLink id="kibTaskManagerPluginApi" text="taskManager"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 53 | 0 | 26 | 8 |
| <DocLink id="kibTaskManagerPluginApi" text="taskManager"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 70 | 0 | 32 | 7 |
| <DocLink id="kibTelemetryPluginApi" text="telemetry"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 41 | 0 | 0 | 0 |
| <DocLink id="kibTelemetryCollectionManagerPluginApi" text="telemetryCollectionManager"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 36 | 0 | 36 | 4 |
| <DocLink id="kibTelemetryCollectionXpackPluginApi" text="telemetryCollectionXpack"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 |

14
api_docs/reporting.json
View file

@ -2089,16 +2089,18 @@
{
"parentPluginId": "reporting",
"id": "def-server.ReportingSetupDeps.taskManager",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "taskManager",
"description": [],
"signature": [
"{ index: string; addMiddleware: (middleware: ",
"Middleware",
") => void; } & Pick<",
"TaskTypeDictionary",
", \"registerTaskDefinitions\">"
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerSetupContract",
"text": "TaskManagerSetupContract"
}
],
"path": "x-pack/plugins/reporting/server/types.ts",
"deprecated": false

56
api_docs/saved_objects_management.json
View file

@ -1587,6 +1587,62 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectManagementTypeInfo",
"type": "Interface",
"tags": [],
"label": "SavedObjectManagementTypeInfo",
"description": [],
"path": "src/plugins/saved_objects_management/common/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectManagementTypeInfo.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/saved_objects_management/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectManagementTypeInfo.namespaceType",
"type": "CompoundType",
"tags": [],
"label": "namespaceType",
"description": [],
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
],
"path": "src/plugins/saved_objects_management/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectManagementTypeInfo.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "src/plugins/saved_objects_management/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectManagementTypeInfo.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"path": "src/plugins/saved_objects_management/common/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedObjectsManagement",
"id": "def-common.SavedObjectMetadata",

2
api_docs/saved_objects_management.mdx
View file

@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 106 | 0 | 93 | 0 |
| 111 | 0 | 98 | 0 |
## Client

321
api_docs/task_manager.json
View file

@ -830,6 +830,188 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition",
"type": "Interface",
"tags": [],
"label": "TaskRegisterDefinition",
"description": [
"\nDefines a task which can be scheduled and run by the Kibana\ntask manager."
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.title",
"type": "string",
"tags": [],
"label": "title",
"description": [
"\nA brief, human-friendly title for this task."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.timeout",
"type": "string",
"tags": [],
"label": "timeout",
"description": [
"\nHow long, in minutes or seconds, the system should wait for the task to complete\nbefore it is considered to be timed out. (e.g. '5m', the default). If\nthe task takes longer than this, Kibana will send it a kill command and\nthe task will be re-attempted."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nAn optional more detailed description of what this task does."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.getRetry",
"type": "Function",
"tags": [],
"label": "getRetry",
"description": [
"\nFunction that customizes how the task should behave when the task fails. This\nfunction can return `true`, `false` or a Date. True will tell task manager\nto retry using default delay logic. False will tell task manager to stop retrying\nthis task. Date will suggest when to the task manager the task should retry.\nThis function isn't used for recurring tasks, those retry as per their configured recurring schedule."
],
"signature": [
"((attempts: number, error: object) => boolean | Date) | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.getRetry.$1",
"type": "number",
"tags": [],
"label": "attempts",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.getRetry.$2",
"type": "Uncategorized",
"tags": [],
"label": "error",
"description": [],
"signature": [
"object"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.createTaskRunner",
"type": "Function",
"tags": [],
"label": "createTaskRunner",
"description": [
"\nCreates an object that has a run function which performs the task's work,\nand an optional cancel function which cancels the task."
],
"signature": [
"(context: ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
},
") => ",
"CancellableTask"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.createTaskRunner.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.RunContext",
"text": "RunContext"
}
],
"path": "x-pack/plugins/task_manager/server/task.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.maxAttempts",
"type": "number",
"tags": [],
"label": "maxAttempts",
"description": [
"\nUp to how many times the task should retry when it fails to run. This will\ndefault to the global variable. The default value, if not specified, is 1."
],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRegisterDefinition.maxConcurrency",
"type": "number",
"tags": [],
"label": "maxConcurrency",
"description": [
"\nThe maximum number tasks of this type that can be run concurrently per Kibana instance.\nSetting this value will force Task Manager to poll for this task type separately from other task types\nwhich can add significant load to the ES cluster, so please use this configuration only when absolutely necessary.\nThe default value, if not given, is 0."
],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
@ -862,6 +1044,30 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskDefinitionRegistry",
"type": "Type",
"tags": [],
"label": "TaskDefinitionRegistry",
"description": [
"\nA mapping of task type id to the task definition."
],
"signature": [
"{ [x: string]: ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskRegisterDefinition",
"text": "TaskRegisterDefinition"
},
"; }"
],
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskRunCreatorFunction",
@ -912,19 +1118,118 @@
"setup": {
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract",
"type": "Type",
"type": "Interface",
"tags": [],
"label": "TaskManagerSetupContract",
"description": [],
"signature": [
"{ index: string; addMiddleware: (middleware: ",
"Middleware",
") => void; } & Pick<",
"TaskTypeDictionary",
", \"registerTaskDefinitions\">"
],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract.index",
"type": "string",
"tags": [
"deprecated"
],
"label": "index",
"description": [],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": true,
"references": [
{
"plugin": "actions",
"path": "x-pack/plugins/actions/server/plugin.ts"
},
{
"plugin": "actions",
"path": "x-pack/plugins/actions/server/plugin.ts"
}
]
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract.addMiddleware",
"type": "Function",
"tags": [],
"label": "addMiddleware",
"description": [],
"signature": [
"(middleware: ",
"Middleware",
") => void"
],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract.addMiddleware.$1",
"type": "Object",
"tags": [],
"label": "middleware",
"description": [],
"signature": [
"Middleware"
],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract.registerTaskDefinitions",
"type": "Function",
"tags": [],
"label": "registerTaskDefinitions",
"description": [
"\nMethod for allowing consumers to register task definitions into the system."
],
"signature": [
"(taskDefinitions: Record<string, ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskRegisterDefinition",
"text": "TaskRegisterDefinition"
},
">) => void"
],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "taskManager",
"id": "def-server.TaskManagerSetupContract.registerTaskDefinitions.$1",
"type": "Object",
"tags": [],
"label": "taskDefinitions",
"description": [
"- The Kibana task definitions dictionary"
],
"signature": [
"Record<string, ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskRegisterDefinition",
"text": "TaskRegisterDefinition"
},
">"
],
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},

2
api_docs/task_manager.mdx
View file

@ -18,7 +18,7 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 53 | 0 | 26 | 8 |
| 70 | 0 | 32 | 7 |
## Server

4
api_docs/url_forwarding.json
View file

@ -91,7 +91,7 @@
},
", { kibanaLegacy }: { kibanaLegacy: { dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }; }) => { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }; }) => { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
{
"pluginId": "urlForwarding",
"scope": "public",
@ -144,7 +144,7 @@
"signature": [
"{ dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; loadAngularBootstrap: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
],
"path": "src/plugins/url_forwarding/public/plugin.ts",
"deprecated": false

9
x-pack/plugins/task_manager/server/index.ts
View file

@ -12,15 +12,18 @@ import { configSchema, TaskManagerConfig, MAX_WORKERS_LIMIT } from './config';
export const plugin = (initContext: PluginInitializerContext) => new TaskManagerPlugin(initContext);
export {
export type {
TaskInstance,
ConcreteTaskInstance,
EphemeralTask,
TaskRunCreatorFunction,
TaskStatus,
RunContext,
} from './task';
export { TaskStatus } from './task';
export type { TaskRegisterDefinition, TaskDefinitionRegistry } from './task_type_dictionary';
export { asInterval } from './lib/intervals';
export {
isUnrecoverableError,
@ -30,7 +33,7 @@ export {
export { RunNowResult } from './task_scheduling';
export { getOldestIdleActionTask } from './queries/oldest_idle_action_task';
export {
export type {
TaskManagerPlugin as TaskManager,
TaskManagerSetupContract,
TaskManagerStartContract,

9
x-pack/plugins/task_manager/server/plugin.ts
View file

@ -32,13 +32,18 @@ import { EphemeralTaskLifecycle } from './ephemeral_task_lifecycle';
import { EphemeralTask } from './task';
import { registerTaskManagerUsageCollector } from './usage';
export type TaskManagerSetupContract = {
export interface TaskManagerSetupContract {
/**
* @deprecated
*/
index: string;
addMiddleware: (middleware: Middleware) => void;
} & Pick<TaskTypeDictionary, 'registerTaskDefinitions'>;
/**
* Method for allowing consumers to register task definitions into the system.
* @param taskDefinitions - The Kibana task definitions dictionary
*/
registerTaskDefinitions: (taskDefinitions: TaskDefinitionRegistry) => void;
}
export type TaskManagerStartContract = Pick<
TaskScheduling,

60
x-pack/plugins/task_manager/server/task_type_dictionary.ts
View file

@ -5,13 +5,63 @@
* 2.0.
*/
import { TaskDefinition, taskDefinitionSchema } from './task';
import { TaskDefinition, taskDefinitionSchema, TaskRunCreatorFunction } from './task';
import { Logger } from '../../../../src/core/server';
export type TaskDefinitionRegistry = Record<
string,
Omit<TaskDefinition, 'type' | 'timeout'> & Pick<Partial<TaskDefinition>, 'timeout'>
>;
/**
* Defines a task which can be scheduled and run by the Kibana
* task manager.
*/
export interface TaskRegisterDefinition {
/**
* A brief, human-friendly title for this task.
*/
title?: string;
/**
* How long, in minutes or seconds, the system should wait for the task to complete
* before it is considered to be timed out. (e.g. '5m', the default). If
* the task takes longer than this, Kibana will send it a kill command and
* the task will be re-attempted.
*/
timeout?: string;
/**
* An optional more detailed description of what this task does.
*/
description?: string;
/**
* Function that customizes how the task should behave when the task fails. This
* function can return `true`, `false` or a Date. True will tell task manager
* to retry using default delay logic. False will tell task manager to stop retrying
* this task. Date will suggest when to the task manager the task should retry.
* This function isn't used for recurring tasks, those retry as per their configured recurring schedule.
*/
getRetry?: (attempts: number, error: object) => boolean | Date;
/**
* Creates an object that has a run function which performs the task's work,
* and an optional cancel function which cancels the task.
*/
createTaskRunner: TaskRunCreatorFunction;
/**
* Up to how many times the task should retry when it fails to run. This will
* default to the global variable. The default value, if not specified, is 1.
*/
maxAttempts?: number;
/**
* The maximum number tasks of this type that can be run concurrently per Kibana instance.
* Setting this value will force Task Manager to poll for this task type separately from other task types
* which can add significant load to the ES cluster, so please use this configuration only when absolutely necessary.
* The default value, if not given, is 0.
*/
maxConcurrency?: number;
}
/**
* A mapping of task type id to the task definition.
*/
export type TaskDefinitionRegistry = Record<string, TaskRegisterDefinition>;
export class TaskTypeDictionary {
private definitions = new Map<string, TaskDefinition>();
private logger: Logger;