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

[api-docs] 2023-08-10 Daily api_docs build (#163551)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/425
This commit is contained in:
Kibana Machine 2023-08-10 00:52:53 -04:00 • committed by GitHub
parent b1b80fe582
commit d5d34c661d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
589 changed files with 19424 additions and 1677 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

2
api_docs/advanced_settings.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

159
api_docs/aiops.devdocs.json
View file

@ -591,6 +591,69 @@
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppDependencies.presentationUtil",
"type": "Object",
"tags": [],
"label": "presentationUtil",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationUtilPluginStart",
"text": "PresentationUtilPluginStart"
},
" | undefined"
],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
},
" | undefined"
],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppDependencies.cases",
"type": "Object",
"tags": [],
"label": "cases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesUiStart",
"text": "CasesUiStart"
},
" | undefined"
],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -895,29 +958,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.analysisType",
"type": "CompoundType",
"tags": [],
"label": "analysisType",
"description": [
"The type of analysis, whether it's a spike or dip"
],
"signature": [
{
"pluginId": "aiops",
"scope": "common",
"docId": "kibAiopsPluginApi",
"section": "def-common.LogRateAnalysisType",
"text": "LogRateAnalysisType"
},
" | undefined"
],
"path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.stickyHistogram",
@ -1127,6 +1167,22 @@
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData.analysisType",
"type": "CompoundType",
"tags": [],
"label": "analysisType",
"description": [
"The type of analysis, whether it's a spike or dip"
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData.significantTerms",
@ -1178,44 +1234,8 @@
}
],
"enums": [],
"misc": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisType",
"type": "Type",
"tags": [],
"label": "LogRateAnalysisType",
"description": [
"\nUnion type of log rate analysis types."
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/plugins/aiops/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "aiops",
"id": "def-public.LOG_RATE_ANALYSIS_TYPE",
"type": "Object",
"tags": [],
"label": "LOG_RATE_ANALYSIS_TYPE",
"description": [
"\nThe type of log rate analysis (spike or dip) will affect how parameters are\npassed to the analysis API endpoint."
],
"signature": [
"{ readonly SPIKE: \"spike\"; readonly DIP: \"dip\"; }"
],
"path": "x-pack/plugins/aiops/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
"misc": [],
"objects": []
},
"server": {
"classes": [],
@ -1280,23 +1300,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-common.LogRateAnalysisType",
"type": "Type",
"tags": [],
"label": "LogRateAnalysisType",
"description": [
"\nUnion type of log rate analysis types."
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/plugins/aiops/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-common.PLUGIN_ID",

10
api_docs/aiops.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
@ -21,22 +21,16 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 60 | 1 | 0 | 0 |
| 60 | 1 | 3 | 0 |
## Client
### Objects
<DocDefinitionList data={aiopsObj.client.objects}/>
### Functions
<DocDefinitionList data={aiopsObj.client.functions}/>
### Interfaces
<DocDefinitionList data={aiopsObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={aiopsObj.client.misc}/>
## Server
### Setup

2
api_docs/alerting.devdocs.json
View file

@ -3303,7 +3303,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",

2
api_docs/alerting.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';

34
api_docs/apm.devdocs.json
View file

@ -81,7 +81,7 @@
"label": "featureFlags",
"description": [],
"signature": [
"{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }"
"{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }"
],
"path": "x-pack/plugins/apm/public/index.ts",
"deprecated": false,
@ -265,7 +265,7 @@
"Observable",
"<Readonly<{} & { indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>; getApmIndices: () => Promise<Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>; getApmIndices: () => Promise<Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
@ -511,7 +511,7 @@
"signature": [
"{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }"
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }"
],
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"deprecated": false,
@ -525,7 +525,7 @@
"label": "featureFlags",
"description": [],
"signature": [
"{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }"
"{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }"
],
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"deprecated": false,
@ -963,7 +963,7 @@
"signature": [
"{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }"
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }"
],
"path": "x-pack/plugins/apm/server/index.ts",
"deprecated": false,
@ -1795,11 +1795,11 @@
"TypeC",
"<{ useSpanName: ",
"Type",
"<boolean, unknown, unknown>; enableServiceTransactionMetrics: ",
"<boolean, boolean, unknown>; enableServiceTransactionMetrics: ",
"Type",
"<boolean, unknown, unknown>; enableContinuousRollups: ",
"<boolean, boolean, unknown>; enableContinuousRollups: ",
"Type",
"<boolean, unknown, unknown>; }>, ",
"<boolean, boolean, unknown>; }>, ",
"TypeC",
"<{ kuery: ",
"StringC",
@ -3169,7 +3169,7 @@
"StringC",
"; searchServiceDestinationMetrics: ",
"Type",
"<boolean, unknown, unknown>; }>]>; }> | undefined; handler: ({}: ",
"<boolean, boolean, unknown>; }>]>; }> | undefined; handler: ({}: ",
{
"pluginId": "apm",
"scope": "server",
@ -3203,7 +3203,7 @@
"StringC",
"; searchServiceDestinationMetrics: ",
"Type",
"<boolean, unknown, unknown>; }>, ",
"<boolean, boolean, unknown>; }>, ",
"TypeC",
"<{ start: ",
"Type",
@ -3269,7 +3269,7 @@
"StringC",
"; searchServiceDestinationMetrics: ",
"Type",
"<boolean, unknown, unknown>; }>, ",
"<boolean, boolean, unknown>; }>, ",
"TypeC",
"<{ start: ",
"Type",
@ -3337,7 +3337,7 @@
"StringC",
"; searchServiceDestinationMetrics: ",
"Type",
"<boolean, unknown, unknown>; }>, ",
"<boolean, boolean, unknown>; }>, ",
"TypeC",
"<{ start: ",
"Type",
@ -4115,7 +4115,7 @@
"PartialC",
"<{ overwrite: ",
"Type",
"<boolean, unknown, unknown>; }>; }>, ",
"<boolean, boolean, unknown>; }>; }>, ",
"TypeC",
"<{ body: ",
"IntersectionC",
@ -4903,7 +4903,7 @@
"Type",
"<number, number, unknown>; useDurationSummary: ",
"Type",
"<boolean, unknown, unknown>; }>, ",
"<boolean, boolean, unknown>; }>, ",
"PartialC",
"<{ transactionName: ",
"StringC",
@ -5089,7 +5089,7 @@
"Type",
"<number, number, unknown>; useDurationSummary: ",
"Type",
"<boolean, unknown, unknown>; }>]>, ",
"<boolean, boolean, unknown>; }>]>, ",
"TypeC",
"<{ transactionNames: ",
"Type",
@ -5181,7 +5181,7 @@
"TypeC",
"<{ useDurationSummary: ",
"Type",
"<boolean, unknown, unknown>; transactionType: ",
"<boolean, boolean, unknown>; transactionType: ",
"StringC",
"; latencyAggregationType: ",
"UnionC",
@ -8116,7 +8116,7 @@
"Observable",
"<Readonly<{} & { indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>"
"; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>"
],
"path": "x-pack/plugins/apm/server/types.ts",
"deprecated": false,

2
api_docs/apm.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

2
api_docs/asset_manager.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
title: "assetManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the assetManager plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.devdocs.json';

2
api_docs/banners.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

2
api_docs/bfetch.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';

2
api_docs/canvas.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas"
image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

15
api_docs/cases.devdocs.json
View file

@ -1091,7 +1091,7 @@
"\nReturn the UI capabilities for each type of operation. These strings must match the values defined in the UI\nhere: x-pack/plugins/cases/public/client/helpers/capabilities.ts"
],
"signature": [
"() => { all: readonly [\"create_cases\", \"read_cases\", \"update_cases\", \"push_cases\"]; read: readonly [\"read_cases\"]; delete: readonly [\"delete_cases\"]; }"
"() => { all: readonly [\"create_cases\", \"read_cases\", \"update_cases\", \"push_cases\", \"cases_connectors\"]; read: readonly [\"read_cases\", \"cases_connectors\"]; delete: readonly [\"delete_cases\"]; }"
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
@ -1108,7 +1108,7 @@
"label": "getApiTags",
"description": [],
"signature": [
"(owner: \"cases\" | \"observability\" | \"securitySolution\") => { all: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", string, string]; read: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", string]; delete: readonly [string]; }"
"(owner: \"cases\" | \"observability\" | \"securitySolution\") => { all: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", \"casesGetConnectorsConfigure\", string, string]; read: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", \"casesGetConnectorsConfigure\", string]; delete: readonly [string]; }"
],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
@ -1312,6 +1312,17 @@
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.connectors",
"type": "boolean",
"tags": [],
"label": "connectors",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

4
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 93 | 0 | 74 | 27 |
| 94 | 0 | 75 | 27 |
## Client

10
api_docs/charts.devdocs.json
View file

@ -1350,7 +1350,15 @@
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; column: number; value: any[]; }; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
", \"rows\" | \"columns\">; cells: { column: number; row: number; }[]; relation?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.BooleanRelation",
"text": "BooleanRelation"
},
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
],
"path": "src/plugins/charts/public/index.ts",
"deprecated": false,

2
api_docs/charts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

2
api_docs/cloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_chat.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
---
import cloudChatObj from './cloud_chat.devdocs.json';

2
api_docs/cloud_chat_provider.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider
title: "cloudChatProvider"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChatProvider plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider']
---
import cloudChatProviderObj from './cloud_chat_provider.devdocs.json';

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_defend.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';

2
api_docs/cloud_experiments.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
---
import cloudExperimentsObj from './cloud_experiments.devdocs.json';

2
api_docs/cloud_security_posture.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

2
api_docs/console.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

2
api_docs/content_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

2
api_docs/controls.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls"
image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';

2
api_docs/custom_integrations.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

2
api_docs/dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';

2
api_docs/dashboard_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

117
api_docs/data.devdocs.json
View file

@ -12999,7 +12999,7 @@
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ",
">, { bfetch, expressions, usageCollection, fieldFormats, security }: ",
"DataPluginSetupDependencies",
") => { search: ",
"ISearchSetup",
@ -13056,7 +13056,7 @@
"id": "def-server.DataServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }",
"label": "{ bfetch, expressions, usageCollection, fieldFormats, security }",
"description": [],
"signature": [
"DataPluginSetupDependencies"
@ -13085,7 +13085,7 @@
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", { fieldFormats, dataViews, taskManager }: ",
", { fieldFormats, dataViews }: ",
"DataPluginStartDependencies",
") => { datatableUtilities: ",
"DatatableUtilitiesService",
@ -13155,7 +13155,7 @@
"id": "def-server.DataServerPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{ fieldFormats, dataViews, taskManager }",
"label": "{ fieldFormats, dataViews }",
"description": [],
"signature": [
"DataPluginStartDependencies"
@ -13568,6 +13568,10 @@
"plugin": "dataViews",
"path": "src/plugins/data_views/server/rest_api_routes/public/update_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts"
@ -13604,10 +13608,6 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/utils/observability_data_views/observability_data_views.ts"
@ -16322,6 +16322,44 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getFieldsForIndexPattern",
@ -17299,6 +17337,21 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.Unnamed.$3",
"type": "boolean",
"tags": [],
"label": "rollupsEnabled",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
@ -21247,6 +21300,10 @@
"plugin": "dataViews",
"path": "src/plugins/data_views/server/rest_api_routes/public/update_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts"
@ -21283,10 +21340,6 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/utils/observability_data_views/observability_data_views.ts"
@ -24872,6 +24925,44 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getFieldsForIndexPattern",
@ -28292,7 +28383,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",

4
api_docs/data.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3295 | 119 | 2573 | 27 |
| 3301 | 119 | 2575 | 27 |
## Client

4
api_docs/data_query.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3295 | 119 | 2573 | 27 |
| 3301 | 119 | 2575 | 27 |
## Client

14
api_docs/data_search.devdocs.json
View file

@ -3889,6 +3889,20 @@
"path": "src/plugins/data/server/search/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "data",
"id": "def-server.SearchStrategyDependencies.rollupsEnabled",
"type": "CompoundType",
"tags": [],
"label": "rollupsEnabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/server/search/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

4
api_docs/data_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3295 | 119 | 2573 | 27 |
| 3301 | 119 | 2575 | 27 |
## Client

2
api_docs/data_view_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

2
api_docs/data_view_field_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

2
api_docs/data_view_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

244
api_docs/data_views.devdocs.json
View file

@ -379,6 +379,10 @@
"plugin": "lens",
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts"
@ -415,10 +419,6 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/utils/observability_data_views/observability_data_views.ts"
@ -4410,6 +4410,44 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getFieldsForIndexPattern",
@ -8229,6 +8267,10 @@
"plugin": "lens",
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts"
@ -8265,10 +8307,6 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/utils/observability_data_views/observability_data_views.ts"
@ -10576,7 +10614,7 @@
"section": "def-server.DataViewsServerPluginSetupDependencies",
"text": "DataViewsServerPluginSetupDependencies"
},
") => {}"
") => { enableRollups: () => boolean; }"
],
"path": "src/plugins/data_views/server/plugin.ts",
"deprecated": false,
@ -11301,6 +11339,44 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getFieldsForIndexPattern",
@ -12278,6 +12354,21 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dataViews",
"id": "def-server.IndexPatternsFetcher.Unnamed.$3",
"type": "boolean",
"tags": [],
"label": "rollupsEnabled",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
@ -13451,6 +13542,39 @@
}
],
"objects": [],
"setup": {
"parentPluginId": "dataViews",
"id": "def-server.DataViewsServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "DataViewsServerPluginSetup",
"description": [
"\nDataViews server plugin setup api"
],
"path": "src/plugins/data_views/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsServerPluginSetup.enableRollups",
"type": "Function",
"tags": [],
"label": "enableRollups",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/data_views/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "dataViews",
"id": "def-server.DataViewsServerPluginStart",
@ -14803,22 +14927,6 @@
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "dataViews",
"id": "def-server.DataViewsServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "DataViewsServerPluginSetup",
"description": [
"\nDataViews server plugin setup api"
],
"path": "src/plugins/data_views/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
@ -15200,6 +15308,10 @@
"plugin": "lens",
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts"
@ -15236,10 +15348,6 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/data_apis.ts"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/utils/observability_data_views/observability_data_views.ts"
@ -18936,6 +19044,44 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getFieldsForIndexPattern",
@ -22036,6 +22182,44 @@
],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"- index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list of index patterns that match indices"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getIds",
@ -24907,7 +25091,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",

4
api_docs/data_views.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1012 | 0 | 243 | 2 |
| 1024 | 0 | 246 | 2 |
## Client

2
api_docs/data_visualizer.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

15
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -18,12 +18,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | ruleRegistry, observability, ml, infra, monitoring, securitySolution, stackAlerts, synthetics, transform, uptime | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | inspector, data, advancedSettings, savedObjects, embeddable, dataViewEditor, unifiedSearch, visualizations, controls, dashboard, licensing, savedObjectsTagging, eventAnnotation, dataViewFieldEditor, lens, @kbn/ml-date-picker, aiops, security, triggersActionsUi, cases, observabilityShared, discover, exploratoryView, fleet, maps, telemetry, dataVisualizer, ml, observability, banners, reporting, timelines, runtimeFields, indexManagement, dashboardEnhanced, imageEmbeddable, graph, monitoring, securitySolution, synthetics, transform, uptime, console, dataViewManagement, filesManagement, uiActions, visTypeVislib | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, triggersActionsUi, ml, logsShared, visTypeTimeseries, apm, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, triggersActionsUi, ml, logsShared, visTypeTimeseries, apm, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, triggersActionsUi, ml, logsShared, visTypeTimeseries, apm, exploratoryView, fleet, dataVisualizer, stackAlerts, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | inspector, data, advancedSettings, savedObjects, embeddable, dataViewEditor, unifiedSearch, visualizations, controls, dashboard, licensing, savedObjectsTagging, eventAnnotation, dataViewFieldEditor, lens, security, triggersActionsUi, cases, @kbn/ml-date-picker, aiops, observabilityShared, discover, exploratoryView, fleet, maps, telemetry, dataVisualizer, ml, observability, banners, reporting, timelines, cloudSecurityPosture, runtimeFields, indexManagement, dashboardEnhanced, imageEmbeddable, graph, monitoring, securitySolution, synthetics, transform, uptime, cloudLinks, console, dataViewManagement, filesManagement, uiActions, visTypeVislib | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | home, data, esUiShared, savedObjectsManagement, exploratoryView, fleet, ml, observability, apm, indexLifecycleManagement, observabilityOnboarding, synthetics, upgradeAssistant, uptime, ux, kibanaOverview | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, management, data, advancedSettings, spaces, savedObjects, visualizations, controls, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, alerting, security, triggersActionsUi, serverless, cases, discover, exploratoryView, fleet, maps, licenseManagement, dataVisualizer, ml, observability, infra, profiling, apm, canvas, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, indexManagement, crossClusterReplication, enterpriseSearch, globalSearchBar, graph, grokdebugger, indexLifecycleManagement, ingestPipelines, logstash, monitoring, observabilityOnboarding, osquery, devTools, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, serverlessSearch, snapshotRestore, synthetics, transform, upgradeAssistant, uptime, ux, watcher, cloudDataMigration, console, dataViewManagement, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, management, data, advancedSettings, spaces, savedObjects, visualizations, serverless, controls, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, security, alerting, triggersActionsUi, cases, aiops, discover, exploratoryView, observabilityAIAssistant, fleet, maps, licenseManagement, dataVisualizer, ml, observability, infra, profiling, apm, canvas, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, indexManagement, crossClusterReplication, enterpriseSearch, globalSearchBar, graph, grokdebugger, indexLifecycleManagement, ingestPipelines, logstash, monitoring, observabilityOnboarding, osquery, devTools, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, serverlessSearch, snapshotRestore, synthetics, transform, upgradeAssistant, uptime, ux, watcher, cloudDataMigration, console, dataViewManagement, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, presentationUtil, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |
@ -102,6 +102,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement | - |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | visualizations, graph | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | dataViews, maps | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.removeScriptedField" text="removeScriptedField"/> | dataViewManagement, dataViews | - |
@ -140,7 +141,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.savedObjectsServiceMock" text="savedObjectsServiceMock"/> | @kbn/core-lifecycle-browser-mocks, @kbn/core, @kbn/core-plugins-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributeSingle" text="SavedObjectAttributeSingle"/> | @kbn/core | - |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, profiling, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, aiops, licenseManagement, ml, profiling, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, osquery, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, fleet, security, securitySolution | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, fleet, security, securitySolution | 8.8.0 |

29
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -399,7 +399,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [log_categorization_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx#:~:text=toMountPoint), [log_categorization_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [log_rate_analysis_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx#:~:text=toMountPoint), [log_rate_analysis_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx#:~:text=toMountPoint), [log_rate_analysis_content_wrapper.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx#:~:text=toMountPoint), [log_rate_analysis_content_wrapper.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx#:~:text=toMountPoint), [change_point_detection_root.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/change_point_detection/change_point_detection_root.tsx#:~:text=toMountPoint)+ 1 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [embeddable_change_point_chart.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/embeddable_change_point_chart.tsx#:~:text=toMountPoint), [embeddable_change_point_chart.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/embeddable_change_point_chart.tsx#:~:text=toMountPoint), [handle_explicit_input.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/handle_explicit_input.tsx#:~:text=toMountPoint), [handle_explicit_input.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/handle_explicit_input.tsx#:~:text=toMountPoint), [log_categorization_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx#:~:text=toMountPoint), [log_categorization_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [show_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx#:~:text=toMountPoint), [log_rate_analysis_app_state.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx#:~:text=toMountPoint)+ 5 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [embeddable_change_point_chart.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/embeddable_change_point_chart.tsx#:~:text=KibanaThemeProvider), [embeddable_change_point_chart.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/embeddable_change_point_chart.tsx#:~:text=KibanaThemeProvider), [embeddable_change_point_chart.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/embeddable/embeddable_change_point_chart.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | [search_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/application/utils/search_utils.ts#:~:text=SimpleSavedObject), [search_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/application/utils/search_utils.ts#:~:text=SimpleSavedObject) | - |
@ -502,11 +504,20 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## cloudLinks
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [theme_darkmode_toggle.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_integrations/cloud_links/public/maybe_add_cloud_links/theme_darkmode_toggle.tsx#:~:text=toMountPoint), [theme_darkmode_toggle.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_integrations/cloud_links/public/maybe_add_cloud_links/theme_darkmode_toggle.tsx#:~:text=toMountPoint) | - |
## cloudSecurityPosture
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | [overview_tab.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx#:~:text=indexPatternId) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [take_action.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/components/take_action.tsx#:~:text=toMountPoint), [take_action.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/components/take_action.tsx#:~:text=toMountPoint) | - |
@ -946,6 +957,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [confirm_modal_promise.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/confirm_modal_promise.tsx#:~:text=toMountPoint), [confirm_modal_promise.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/confirm_modal_promise.tsx#:~:text=toMountPoint), [workspace_top_nav_menu.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/workspace_layout/workspace_top_nav_menu.tsx#:~:text=toMountPoint), [workspace_top_nav_menu.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/workspace_layout/workspace_top_nav_menu.tsx#:~:text=toMountPoint), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=toMountPoint), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=KibanaThemeProvider), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=KibanaThemeProvider), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | [source_picker.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/source_picker.tsx#:~:text=includeFields) | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | [app_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/types/app_state.ts#:~:text=SimpleSavedObject), [app_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/types/app_state.ts#:~:text=SimpleSavedObject), [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/find_object_by_title.test.ts#:~:text=SimpleSavedObject), [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/find_object_by_title.test.ts#:~:text=SimpleSavedObject) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsCreateOptions" text="SavedObjectsCreateOptions"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectsCreateOptions), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectsCreateOptions) | - |
@ -1203,7 +1215,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts#:~:text=title), [rollup.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts#:~:text=title), [alerting_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/lib/alerts/alerting_service.ts#:~:text=title), [data_recognizer.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts#:~:text=title), [configuration_step_details.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_details.tsx#:~:text=title), [data_loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/datavisualizer/index_based/data_loader/data_loader.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title)+ 40 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts#:~:text=title), [rollup.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts#:~:text=title), [alerting_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/lib/alerts/alerting_service.ts#:~:text=title), [data_recognizer.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts#:~:text=title), [configuration_step_details.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_details.tsx#:~:text=title), [data_loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/datavisualizer/index_based/data_loader/data_loader.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title)+ 40 more | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_frame_analytics/index_patterns.ts#:~:text=title), [rollup.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts#:~:text=title), [alerting_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/lib/alerts/alerting_service.ts#:~:text=title), [data_recognizer.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts#:~:text=title), [configuration_step_details.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_details.tsx#:~:text=title), [data_loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/datavisualizer/index_based/data_loader/data_loader.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title), [use_index_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts#:~:text=title)+ 15 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [clone_action_name.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx#:~:text=toMountPoint), [clone_action_name.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx#:~:text=toMountPoint), [force_stop_dialog.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/force_stop_dialog.tsx#:~:text=toMountPoint), [force_stop_dialog.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/force_stop_dialog.tsx#:~:text=toMountPoint), [deployment_setup.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/deployment_setup.tsx#:~:text=toMountPoint), [deployment_setup.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/deployment_setup.tsx#:~:text=toMountPoint), [header_menu_portal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/header_menu_portal/header_menu_portal.tsx#:~:text=toMountPoint), [header_menu_portal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/header_menu_portal/header_menu_portal.tsx#:~:text=toMountPoint), [create_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/job_creation/common/create_flyout.tsx#:~:text=toMountPoint), [create_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/job_creation/common/create_flyout.tsx#:~:text=toMountPoint)+ 10 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [clone_action_name.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx#:~:text=toMountPoint), [clone_action_name.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx#:~:text=toMountPoint), [force_stop_dialog.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/force_stop_dialog.tsx#:~:text=toMountPoint), [force_stop_dialog.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/force_stop_dialog.tsx#:~:text=toMountPoint), [deployment_setup.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/deployment_setup.tsx#:~:text=toMountPoint), [deployment_setup.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/model_management/deployment_setup.tsx#:~:text=toMountPoint), [header_menu_portal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/header_menu_portal/header_menu_portal.tsx#:~:text=toMountPoint), [header_menu_portal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/header_menu_portal/header_menu_portal.tsx#:~:text=toMountPoint), [resolve_job_selection.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/common/resolve_job_selection.tsx#:~:text=toMountPoint), [resolve_job_selection.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/common/resolve_job_selection.tsx#:~:text=toMountPoint)+ 10 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [anomaly_charts_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_charts/anomaly_charts_embeddable.tsx#:~:text=KibanaThemeProvider), [anomaly_charts_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_charts/anomaly_charts_embeddable.tsx#:~:text=KibanaThemeProvider), [anomaly_charts_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_charts/anomaly_charts_embeddable.tsx#:~:text=KibanaThemeProvider), [anomaly_swimlane_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_swimlane/anomaly_swimlane_embeddable.tsx#:~:text=KibanaThemeProvider), [anomaly_swimlane_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_swimlane/anomaly_swimlane_embeddable.tsx#:~:text=KibanaThemeProvider), [anomaly_swimlane_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/embeddables/anomaly_swimlane/anomaly_swimlane_embeddable.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=KibanaThemeProvider), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=KibanaThemeProvider)+ 2 more | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 |
@ -1257,6 +1269,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## observabilityAIAssistant
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_ai_assistant/public/application.tsx#:~:text=KibanaThemeProvider), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_ai_assistant/public/application.tsx#:~:text=KibanaThemeProvider), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_ai_assistant/public/application.tsx#:~:text=KibanaThemeProvider) | - |
## observabilityOnboarding
| Deprecated API | Reference location(s) | Remove By |
@ -1462,7 +1482,7 @@ This is relied on by the reporting feature, and should be removed once reporting
migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 15 more | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [use_update_user_profile.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/account_management/user_profile/use_update_user_profile.tsx#:~:text=toMountPoint), [use_update_user_profile.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/account_management/user_profile/use_update_user_profile.tsx#:~:text=toMountPoint), [session_expiration_toast.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/session/session_expiration_toast.tsx#:~:text=toMountPoint), [session_expiration_toast.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/session/session_expiration_toast.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [account_management_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/account_management/account_management_app.tsx#:~:text=toMountPoint), [account_management_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/account_management/account_management_app.tsx#:~:text=toMountPoint), [session_expiration_toast.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/session/session_expiration_toast.tsx#:~:text=toMountPoint), [session_expiration_toast.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/session/session_expiration_toast.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [access_agreement_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/access_agreement/access_agreement_page.tsx#:~:text=KibanaThemeProvider), [access_agreement_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/access_agreement/access_agreement_page.tsx#:~:text=KibanaThemeProvider), [access_agreement_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/access_agreement/access_agreement_page.tsx#:~:text=KibanaThemeProvider), [logged_out_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logged_out/logged_out_page.tsx#:~:text=KibanaThemeProvider), [logged_out_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logged_out/logged_out_page.tsx#:~:text=KibanaThemeProvider), [logged_out_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logged_out/logged_out_page.tsx#:~:text=KibanaThemeProvider), [login_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/login/login_page.tsx#:~:text=KibanaThemeProvider), [login_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/login/login_page.tsx#:~:text=KibanaThemeProvider), [login_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/login/login_page.tsx#:~:text=KibanaThemeProvider), [overwritten_session_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/overwritten_session/overwritten_session_page.tsx#:~:text=KibanaThemeProvider)+ 20 more | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
@ -1818,6 +1838,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [confirm_modal_promise.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/confirm_modal_promise.tsx#:~:text=toMountPoint), [confirm_modal_promise.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/confirm_modal_promise.tsx#:~:text=toMountPoint), [use_visualize_app_state.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/utils/use/use_visualize_app_state.tsx#:~:text=toMountPoint), [use_visualize_app_state.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/utils/use/use_visualize_app_state.tsx#:~:text=toMountPoint), [visualize_no_match.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_no_match.tsx#:~:text=toMountPoint), [visualize_no_match.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_no_match.tsx#:~:text=toMountPoint), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=toMountPoint), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [use_visualize_app_state.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/utils/use/use_visualize_app_state.tsx#:~:text=KibanaThemeProvider), [use_visualize_app_state.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/utils/use/use_visualize_app_state.tsx#:~:text=KibanaThemeProvider), [use_visualize_app_state.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/utils/use/use_visualize_app_state.tsx#:~:text=KibanaThemeProvider), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=KibanaThemeProvider), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=KibanaThemeProvider), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=KibanaThemeProvider), [show_new_vis.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/wizard/show_new_vis.tsx#:~:text=KibanaThemeProvider), [show_new_vis.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/wizard/show_new_vis.tsx#:~:text=KibanaThemeProvider), [show_new_vis.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/wizard/show_new_vis.tsx#:~:text=KibanaThemeProvider), [visualize_no_match.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_no_match.tsx#:~:text=KibanaThemeProvider)+ 5 more | - |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | [search_selection.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx#:~:text=includeFields), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=includeFields) | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=savedObjects), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=savedObjects) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=SavedObjectsClientContract), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=SavedObjectsClientContract) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.delete" text="delete"/> | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=delete) | - |

4
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -120,7 +120,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| ml | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| ml | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/aiops/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
| ml | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 |

2
api_docs/dev_tools.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

2
api_docs/discover.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';

2
api_docs/discover_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

2
api_docs/ecs_data_quality_dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

30
api_docs/embeddable.devdocs.json
View file

@ -7589,6 +7589,26 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableStartDependencies.contentManagement",
"type": "Object",
"tags": [],
"label": "contentManagement",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "public",
"docId": "kibContentManagementPluginApi",
"section": "def-public.ContentManagementPublicStart",
"text": "ContentManagementPublicStart"
}
],
"path": "src/plugins/embeddable/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableStartDependencies.savedObjectsManagement",
@ -9155,7 +9175,15 @@
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; column: number; value: any[]; }; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
", \"rows\" | \"columns\">; cells: { column: number; row: number; }[]; relation?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.BooleanRelation",
"text": "BooleanRelation"
},
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,

4
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 535 | 11 | 437 | 7 |
| 536 | 11 | 438 | 7 |
## Client

2
api_docs/embeddable_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

2
api_docs/encrypted_saved_objects.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

2
api_docs/enterprise_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

2
api_docs/es_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

59
api_docs/event_annotation.devdocs.json
View file

@ -461,7 +461,15 @@
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<unknown>; }) => void; onCreateNew: () => void; }) => JSX.Element"
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">; }) => void; onCreateNew: () => void; }) => JSX.Element"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
@ -508,7 +516,15 @@
"section": "def-common.SavedObjectCommon",
"text": "SavedObjectCommon"
},
"<unknown>; }) => void"
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">; }) => void"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
@ -567,13 +583,21 @@
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"pluginId": "@kbn/content-management-utils",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-common.SOWithMetadata",
"text": "SOWithMetadata"
},
"<unknown>"
"<",
{
"pluginId": "savedObjectsFinder",
"scope": "common",
"docId": "kibSavedObjectsFinderPluginApi",
"section": "def-common.FinderAttributes",
"text": "FinderAttributes"
},
">"
],
"path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false,
@ -694,27 +718,6 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventAnnotation",
"id": "def-public.EventAnnotationService.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "savedObjectsManagement",
"description": [],
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementPluginStart",
"text": "SavedObjectsManagementPluginStart"
}
],
"path": "src/plugins/event_annotation/public/event_annotation_service/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []

4
api_docs/event_annotation.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 192 | 30 | 192 | 2 |
| 191 | 30 | 191 | 2 |
## Client

79
api_docs/event_log.devdocs.json
View file

@ -143,85 +143,6 @@
],
"returnComment": []
},
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.doesIlmPolicyExist",
"type": "Function",
"tags": [],
"label": "doesIlmPolicyExist",
"description": [],
"signature": [
"(policyName: string) => Promise<boolean>"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.doesIlmPolicyExist.$1",
"type": "string",
"tags": [],
"label": "policyName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.createIlmPolicy",
"type": "Function",
"tags": [],
"label": "createIlmPolicy",
"description": [],
"signature": [
"(policyName: string, policy: Record<string, unknown>) => Promise<void>"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.createIlmPolicy.$1",
"type": "string",
"tags": [],
"label": "policyName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.createIlmPolicy.$2",
"type": "Object",
"tags": [],
"label": "policy",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "eventLog",
"id": "def-server.ClusterClientAdapter.doesIndexTemplateExist",

4
api_docs/event_log.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 116 | 0 | 116 | 11 |
| 111 | 0 | 111 | 11 |
## Server

2
api_docs/exploratory_view.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

2
api_docs/expression_error.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

2
api_docs/expression_gauge.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';

18
api_docs/expression_heatmap.devdocs.json
View file

@ -897,7 +897,23 @@
"section": "def-common.Datatable",
"text": "Datatable"
},
"; column: number; range: number[]; timeFieldName?: string | undefined; }) => void; paletteService: ",
"; column: number; range: number[]; timeFieldName?: string | undefined; }) => void; onClickMultiValue: (data: { data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; cells: { column: number; row: number; }[]; relation?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.BooleanRelation",
"text": "BooleanRelation"
},
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }) => void; paletteService: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",

2
api_docs/expression_heatmap.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

2
api_docs/expression_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

2
api_docs/expression_legacy_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

2
api_docs/expression_metric.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

2
api_docs/expression_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

2
api_docs/expression_partition_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

2
api_docs/expression_repeat_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

2
api_docs/expression_reveal_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

2
api_docs/expression_shape.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

2
api_docs/expression_tagcloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

2
api_docs/expression_x_y.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

2
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';

2
api_docs/features.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features"
image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/file_upload.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

12
api_docs/files.devdocs.json
View file

@ -577,6 +577,14 @@
"plugin": "cases",
"path": "x-pack/plugins/cases/public/plugin.ts"
},
{
"plugin": "cases",
"path": "x-pack/plugins/cases/public/plugin.test.ts"
},
{
"plugin": "cases",
"path": "x-pack/plugins/cases/public/plugin.test.ts"
},
{
"plugin": "imageEmbeddable",
"path": "src/plugins/image_embeddable/public/plugin.ts"
@ -5458,6 +5466,10 @@
{
"plugin": "cases",
"path": "x-pack/plugins/cases/server/client/factory.ts"
},
{
"plugin": "cases",
"path": "x-pack/plugins/cases/server/plugin.test.ts"
}
]
}

2
api_docs/files.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

2
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';

2
api_docs/global_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

2
api_docs/guided_onboarding.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

2
api_docs/home.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home"
image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

2
api_docs/image_embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

2
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/infra.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
title: "infra"
image: https://source.unsplash.com/400x175/?github
description: API docs for the infra plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

2
api_docs/inspector.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
title: "inspector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inspector plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

2
api_docs/interactive_setup.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

2
api_docs/kbn_ace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
title: "@kbn/ace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ace plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

284
api_docs/kbn_aiops_components.devdocs.json
View file

@ -23,15 +23,13 @@
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChart",
"type": "Function",
"tags": [
"constructor"
],
"tags": [],
"label": "DocumentCountChart",
"description": [
"\nDocument count chart with draggable brushes to select time ranges\nby default use `Baseline` and `Deviation` for the badge names"
"\nDocument count chart with draggable brushes to select time ranges\nby default use `Baseline` and `Deviation` for the badge names\n"
],
"signature": [
"({ dependencies, brushSelectionUpdateHandler, width, chartPoints, chartPointsSplit, timeRangeEarliest, timeRangeLatest, interval, chartPointsSplitLabel, isBrushCleared, autoAnalysisStart, barColorOverride, barStyleAccessor, barHighlightColorOverride, deviationBrush, baselineBrush, }: React.PropsWithChildren<",
"(props: React.PropsWithChildren<",
{
"pluginId": "@kbn/aiops-components",
"scope": "common",
@ -50,8 +48,10 @@
"id": "def-common.DocumentCountChart.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n dependencies,\n brushSelectionUpdateHandler,\n width,\n chartPoints,\n chartPointsSplit,\n timeRangeEarliest,\n timeRangeLatest,\n interval,\n chartPointsSplitLabel,\n isBrushCleared,\n autoAnalysisStart,\n barColorOverride,\n barStyleAccessor,\n barHighlightColorOverride,\n deviationBrush = {},\n baselineBrush = {},\n}",
"description": [],
"label": "props",
"description": [
"DocumentCountChart component props"
],
"signature": [
"React.PropsWithChildren<",
{
@ -69,22 +69,22 @@
"isRequired": true
}
],
"returnComment": [],
"returnComment": [
"The DocumentCountChart component."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrush",
"type": "Function",
"tags": [
"type"
],
"tags": [],
"label": "DualBrush",
"description": [
"\nDualBrush React Component\nDual brush component that overlays the document count chart"
"\nDualBrush React Component\nDual brush component that overlays the document count chart\n"
],
"signature": [
"({\n /**\n * Min and max numeric timestamps for the two brushes\n */\n windowParameters,\n /**\n * Min timestamp for x domain\n */\n min,\n /**\n * Max timestamp for x domain\n */\n max,\n /**\n * Callback function whenever the brush changes\n */\n onChange,\n /**\n * Margin left\n */\n marginLeft,\n /**\n * Nearest timestamps to snap to the brushes to\n */\n snapTimestamps,\n /**\n * Width\n */\n width,\n}: DualBrushProps) => JSX.Element"
"(props: React.PropsWithChildren<DualBrushProps>) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush.tsx",
"deprecated": false,
@ -93,12 +93,14 @@
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrush.$1",
"type": "Object",
"type": "CompoundType",
"tags": [],
"label": "{\n /**\n * Min and max numeric timestamps for the two brushes\n */\n windowParameters,\n /**\n * Min timestamp for x domain\n */\n min,\n /**\n * Max timestamp for x domain\n */\n max,\n /**\n * Callback function whenever the brush changes\n */\n onChange,\n /**\n * Margin left\n */\n marginLeft,\n /**\n * Nearest timestamps to snap to the brushes to\n */\n snapTimestamps,\n /**\n * Width\n */\n width,\n}",
"description": [],
"label": "props",
"description": [
"DualBrushProps component props"
],
"signature": [
"DualBrushProps"
"React.PropsWithChildren<DualBrushProps>"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush.tsx",
"deprecated": false,
@ -115,15 +117,13 @@
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrushAnnotation",
"type": "Function",
"tags": [
"type"
],
"tags": [],
"label": "DualBrushAnnotation",
"description": [
"\nDualBrushAnnotation React Component\nDual brush annotation component that overlays the document count chart"
"\nDualBrushAnnotation React Component\nDual brush annotation component that overlays the document count chart\n"
],
"signature": [
"({ id, min, max, style }: React.PropsWithChildren<BrushAnnotationProps>) => JSX.Element"
"(props: React.PropsWithChildren<BrushAnnotationProps>) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush_annotation.tsx",
"deprecated": false,
@ -134,8 +134,10 @@
"id": "def-common.DualBrushAnnotation.$1",
"type": "CompoundType",
"tags": [],
"label": "{ id, min, max, style }",
"description": [],
"label": "props",
"description": [
"BrushAnnotationProps component props"
],
"signature": [
"React.PropsWithChildren<BrushAnnotationProps>"
],
@ -154,15 +156,13 @@
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.ProgressControls",
"type": "Function",
"tags": [
"type"
],
"tags": [],
"label": "ProgressControls",
"description": [
"\nProgressControls React Component\nComponent with ability to Run & cancel analysis\nby default use `Baseline` and `Deviation` for the badge name"
"\nProgressControls React Component\nComponent with ability to Run & cancel analysis\nby default uses `Baseline` and `Deviation` for the badge name\n"
],
"signature": [
"({ children, isBrushCleared, progress, progressMessage, onRefresh, onCancel, onReset, isRunning, shouldRerunAnalysis, runAnalysisDisabled, }: React.PropsWithChildren<ProgressControlProps>) => JSX.Element"
"(props: React.PropsWithChildren<ProgressControlProps>) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/progress_controls/progress_controls.tsx",
"deprecated": false,
@ -173,8 +173,10 @@
"id": "def-common.ProgressControls.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n isBrushCleared,\n progress,\n progressMessage,\n onRefresh,\n onCancel,\n onReset,\n isRunning,\n shouldRerunAnalysis,\n runAnalysisDisabled = false,\n}",
"description": [],
"label": "props",
"description": [
"ProgressControls component props"
],
"signature": [
"React.PropsWithChildren<ProgressControlProps>"
],
@ -193,12 +195,12 @@
"interfaces": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChartPoint",
"id": "def-common.BrushSettings",
"type": "Interface",
"tags": [],
"label": "DocumentCountChartPoint",
"label": "BrushSettings",
"description": [
"\nDatum for the bar chart"
"\nBrush settings"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
@ -206,15 +208,15 @@
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChartPoint.time",
"type": "CompoundType",
"id": "def-common.BrushSettings.label",
"type": "string",
"tags": [],
"label": "time",
"label": "label",
"description": [
"\nTime of bucket"
"\nOptional label name for brush"
],
"signature": [
"string | number"
"string | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
@ -222,12 +224,34 @@
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChartPoint.value",
"id": "def-common.BrushSettings.annotationStyle",
"type": "Object",
"tags": [],
"label": "annotationStyle",
"description": [
"\nOptional style for brush"
],
"signature": [
"RecursivePartial",
"<",
"RectAnnotationStyle",
"> | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.BrushSettings.badgeWidth",
"type": "number",
"tags": [],
"label": "value",
"label": "badgeWidth",
"description": [
"\nNumber of doc count for that time bucket"
"\nOptional width for brush"
],
"signature": [
"number | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
@ -304,61 +328,21 @@
"tags": [],
"label": "brushSelectionUpdateHandler",
"description": [
"Optional callback function which gets called the brush selection has changed"
"Optional callback for handling brush selection updates"
],
"signature": [
"((windowParameters: ",
{
"pluginId": "@kbn/aiops-utils",
"pluginId": "@kbn/aiops-components",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
"docId": "kibKbnAiopsComponentsPluginApi",
"section": "def-common.BrushSelectionUpdateHandler",
"text": "BrushSelectionUpdateHandler"
},
", force: boolean) => void) | undefined"
" | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChartProps.brushSelectionUpdateHandler.$1",
"type": "Object",
"tags": [],
"label": "windowParameters",
"description": [],
"signature": [
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DocumentCountChartProps.brushSelectionUpdateHandler.$2",
"type": "boolean",
"tags": [],
"label": "force",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
"trackAdoption": false
},
{
"parentPluginId": "@kbn/aiops-components",
@ -387,11 +371,11 @@
],
"signature": [
{
"pluginId": "@kbn/aiops-components",
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsComponentsPluginApi",
"section": "def-common.DocumentCountChartPoint",
"text": "DocumentCountChartPoint"
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateHistogramItem",
"text": "LogRateHistogramItem"
},
"[]"
],
@ -410,11 +394,11 @@
],
"signature": [
{
"pluginId": "@kbn/aiops-components",
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsComponentsPluginApi",
"section": "def-common.DocumentCountChartPoint",
"text": "DocumentCountChartPoint"
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateHistogramItem",
"text": "LogRateHistogramItem"
},
"[] | undefined"
],
@ -570,7 +554,13 @@
"Optional settings override for the 'deviation' brush"
],
"signature": [
"BrushSettings",
{
"pluginId": "@kbn/aiops-components",
"scope": "common",
"docId": "kibKbnAiopsComponentsPluginApi",
"section": "def-common.BrushSettings",
"text": "BrushSettings"
},
" | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
@ -587,7 +577,13 @@
"Optional settings override for the 'baseline' brush"
],
"signature": [
"BrushSettings",
{
"pluginId": "@kbn/aiops-components",
"scope": "common",
"docId": "kibKbnAiopsComponentsPluginApi",
"section": "def-common.BrushSettings",
"text": "BrushSettings"
},
" | undefined"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
@ -599,7 +595,95 @@
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.BrushSelectionUpdateHandler",
"type": "Type",
"tags": [],
"label": "BrushSelectionUpdateHandler",
"description": [
"\nCallback function which gets called when the brush selection has changed\n"
],
"signature": [
"(windowParameters: ",
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
},
", force: boolean, logRateAnalysisType: ",
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateAnalysisType",
"text": "LogRateAnalysisType"
},
") => void"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.BrushSelectionUpdateHandler.$1",
"type": "Object",
"tags": [],
"label": "windowParameters",
"description": [
"Baseline and deviation time ranges."
],
"signature": [
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.BrushSelectionUpdateHandler.$2",
"type": "boolean",
"tags": [],
"label": "force",
"description": [
"Force update"
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.BrushSelectionUpdateHandler.$3",
"type": "CompoundType",
"tags": [],
"label": "logRateAnalysisType",
"description": [
"`spike` or `dip` based on median log rate bucket size"
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/packages/ml/aiops_components/src/document_count_chart/document_count_chart.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": []
}
}

7
api_docs/kbn_aiops_components.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
title: "@kbn/aiops-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-components plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 30 | 0 | 6 | 1 |
| 33 | 0 | 0 | 0 |
## Common
@ -31,3 +31,6 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi
### Interfaces
<DocDefinitionList data={kbnAiopsComponentsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={kbnAiopsComponentsObj.common.misc}/>

201
api_docs/kbn_aiops_utils.devdocs.json
View file

@ -19,6 +19,98 @@
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.getLogRateAnalysisType",
"type": "Function",
"tags": [],
"label": "getLogRateAnalysisType",
"description": [
"\nIdentify the log rate analysis type based on the baseline/deviation\ntime ranges on a given log rate histogram.\n"
],
"signature": [
"(logRateHistogram: ",
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateHistogramItem",
"text": "LogRateHistogramItem"
},
"[], windowParameters: ",
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
},
") => ",
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateAnalysisType",
"text": "LogRateAnalysisType"
}
],
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.getLogRateAnalysisType.$1",
"type": "Array",
"tags": [],
"label": "logRateHistogram",
"description": [
"The log rate histogram."
],
"signature": [
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.LogRateHistogramItem",
"text": "LogRateHistogramItem"
},
"[]"
],
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.getLogRateAnalysisType.$2",
"type": "Object",
"tags": [],
"label": "windowParameters",
"description": [
"The window parameters with baseline and deviation time range."
],
"signature": [
{
"pluginId": "@kbn/aiops-utils",
"scope": "common",
"docId": "kibKbnAiopsUtilsPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The log rate analysis type."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.getSnappedWindowParameters",
@ -46,7 +138,7 @@
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -68,7 +160,7 @@
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -85,7 +177,7 @@
"signature": [
"number[]"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -115,7 +207,7 @@
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -131,7 +223,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -148,7 +240,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -165,7 +257,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -178,6 +270,51 @@
}
],
"interfaces": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.LogRateHistogramItem",
"type": "Interface",
"tags": [],
"label": "LogRateHistogramItem",
"description": [
"\nLog rate histogram item"
],
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.LogRateHistogramItem.time",
"type": "CompoundType",
"tags": [],
"label": "time",
"description": [
"\nTime of bucket"
],
"signature": [
"string | number"
],
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.LogRateHistogramItem.value",
"type": "number",
"tags": [],
"label": "value",
"description": [
"\nNumber of doc count for that time bucket"
],
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.WindowParameters",
@ -191,7 +328,7 @@
"description": [
"\nTime range definition for baseline and deviation to be used by log rate analysis.\n"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -206,7 +343,7 @@
"description": [
"\nBaseline minimum value"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false
},
@ -221,7 +358,7 @@
"description": [
"\nBaseline maximum value"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false
},
@ -236,7 +373,7 @@
"description": [
"\nDeviation minimum value"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false
},
@ -251,7 +388,7 @@
"description": [
"\nDeviation maximum value"
],
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
"deprecated": false,
"trackAdoption": false
}
@ -260,7 +397,43 @@
}
],
"enums": [],
"misc": [],
"objects": []
"misc": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.LogRateAnalysisType",
"type": "Type",
"tags": [],
"label": "LogRateAnalysisType",
"description": [
"\nUnion type of log rate analysis types."
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/packages/ml/aiops_utils/log_rate_analysis_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.LOG_RATE_ANALYSIS_TYPE",
"type": "Object",
"tags": [],
"label": "LOG_RATE_ANALYSIS_TYPE",
"description": [
"\nThe type of log rate analysis (spike or dip) will affect how parameters are\npassed to the analysis API endpoint."
],
"signature": [
"{ readonly SPIKE: \"spike\"; readonly DIP: \"dip\"; }"
],
"path": "x-pack/packages/ml/aiops_utils/log_rate_analysis_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}

10
api_docs/kbn_aiops_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
title: "@kbn/aiops-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-utils plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';
@ -21,13 +21,19 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 12 | 0 | 0 | 0 |
| 20 | 0 | 0 | 0 |
## Common
### Objects
<DocDefinitionList data={kbnAiopsUtilsObj.common.objects}/>
### Functions
<DocDefinitionList data={kbnAiopsUtilsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={kbnAiopsUtilsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={kbnAiopsUtilsObj.common.misc}/>

2
api_docs/kbn_alerting_state_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
title: "@kbn/alerting-state-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-state-types plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

2
api_docs/kbn_alerts_as_data_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
title: "@kbn/alerts-as-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-as-data-utils plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

2
api_docs/kbn_alerts_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
title: "@kbn/alerts-ui-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-ui-shared plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';

2
api_docs/kbn_analytics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

8
api_docs/kbn_analytics_client.devdocs.json
View file

@ -1316,14 +1316,14 @@
"plugin": "cloud",
"path": "x-pack/plugins/cloud/common/register_cloud_deployment_id_analytics_context.ts"
},
{
"plugin": "telemetry",
"path": "src/plugins/telemetry/server/plugin.ts"
},
{
"plugin": "security",
"path": "x-pack/plugins/security/public/analytics/register_user_context.ts"
},
{
"plugin": "telemetry",
"path": "src/plugins/telemetry/server/plugin.ts"
},
{
"plugin": "telemetry",
"path": "src/plugins/telemetry/public/plugin.ts"

2
api_docs/kbn_analytics_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
title: "@kbn/analytics-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-client plugin
date: 2023-08-08
date: 2023-08-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

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