mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
[api-docs] 2024-08-23 Daily api_docs build (#191157)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/808
This commit is contained in:
parent
c95f01b97b
commit
705539edc3
768 changed files with 7152 additions and 1336 deletions
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
---
|
||||
import actionsObj from './actions.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
|
|||
title: "aiAssistantManagementSelection"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the aiAssistantManagementSelection plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
|
||||
---
|
||||
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
@ -3286,7 +3286,7 @@
|
|||
"label": "monitoring",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; } & {}>; }>; }>; }> | undefined"
|
||||
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"ruleExecution\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; } & {}>; }>; }>; }> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
||||
"deprecated": false,
|
||||
|
@ -3342,7 +3342,7 @@
|
|||
"label": "lastRun",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined"
|
||||
"Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"ruleExecution\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
||||
"deprecated": false,
|
||||
|
@ -4100,7 +4100,7 @@
|
|||
"label": "schemas",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ params?: { type: \"zod\"; schema: Zod.ZodObject<Zod.ZodRawShape, Zod.UnknownKeysParam, Zod.ZodTypeAny, { [x: string]: any; }, { [x: string]: any; }> | Zod.ZodIntersection<Zod.ZodTypeAny, Zod.ZodTypeAny>; } | { type: \"config-schema\"; schema: ",
|
||||
"{ params?: { type: \"zod\"; schema: any; } | { type: \"config-schema\"; schema: ",
|
||||
{
|
||||
"pluginId": "@kbn/config-schema",
|
||||
"scope": "common",
|
||||
|
@ -5044,7 +5044,7 @@
|
|||
},
|
||||
"<Params>>; getAlertState: (params: ",
|
||||
"GetAlertStateParams",
|
||||
") => Promise<void | Readonly<{ alertTypeState?: Record<string, any> | undefined; alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; previousStartedAt?: string | null | undefined; summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; } & {}>>; getAlertSummary: (params: ",
|
||||
") => Promise<void | Readonly<{ alertTypeState?: Record<string, any> | undefined; alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ flapping?: boolean | undefined; uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ flapping?: boolean | undefined; uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; previousStartedAt?: string | null | undefined; summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; } & {}>>; getAlertSummary: (params: ",
|
||||
"GetAlertSummaryParams",
|
||||
") => Promise<",
|
||||
{
|
||||
|
@ -8529,6 +8529,20 @@
|
|||
"path": "packages/kbn-alerting-types/rule_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.Rule.flapping",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "flapping",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ lookBackWindow: number; statusChangeThreshold: number; } | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -9416,6 +9430,42 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleSpecificFlappingProperties",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleSpecificFlappingProperties",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleSpecificFlappingProperties.lookBackWindow",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "lookBackWindow",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleSpecificFlappingProperties.statusChangeThreshold",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "statusChangeThreshold",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RulesSettings",
|
||||
|
@ -10665,7 +10715,7 @@
|
|||
"label": "LatestAlertInstanceMetaSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly uuid?: string | undefined; readonly lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; readonly flappingHistory?: boolean[] | undefined; readonly flapping?: boolean | undefined; readonly maintenanceWindowIds?: string[] | undefined; readonly pendingRecoveredCount?: number | undefined; readonly activeCount?: number | undefined; }"
|
||||
"{ readonly flapping?: boolean | undefined; readonly uuid?: string | undefined; readonly lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; readonly flappingHistory?: boolean[] | undefined; readonly maintenanceWindowIds?: string[] | undefined; readonly pendingRecoveredCount?: number | undefined; readonly activeCount?: number | undefined; }"
|
||||
],
|
||||
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -10710,7 +10760,7 @@
|
|||
"label": "LatestRawAlertInstanceSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; readonly state?: Record<string, any> | undefined; }"
|
||||
"{ readonly meta?: Readonly<{ flapping?: boolean | undefined; uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; readonly state?: Record<string, any> | undefined; }"
|
||||
],
|
||||
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -10725,7 +10775,7 @@
|
|||
"label": "LatestTaskStateSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly alertTypeState?: Record<string, any> | undefined; readonly alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly previousStartedAt?: string | null | undefined; readonly summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; }"
|
||||
"{ readonly alertTypeState?: Record<string, any> | undefined; readonly alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ flapping?: boolean | undefined; uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ flapping?: boolean | undefined; uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly previousStartedAt?: string | null | undefined; readonly summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; }"
|
||||
],
|
||||
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -11080,7 +11130,7 @@
|
|||
"signature": [
|
||||
"20"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_flapping.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
@ -11110,7 +11160,7 @@
|
|||
"signature": [
|
||||
"20"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_flapping.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
@ -11125,7 +11175,7 @@
|
|||
"signature": [
|
||||
"2"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_flapping.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
@ -11155,7 +11205,7 @@
|
|||
"signature": [
|
||||
"2"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_flapping.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
---
|
||||
import alertingObj from './alerting.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 871 | 1 | 839 | 52 |
|
||||
| 875 | 1 | 843 | 52 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
|
|||
title: "apmDataAccess"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the apmDataAccess plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
|
||||
---
|
||||
import apmDataAccessObj from './apm_data_access.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
---
|
||||
import bannersObj from './banners.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
---
|
||||
import bfetchObj from './bfetch.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
---
|
||||
import chartsObj from './charts.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
|
||||
---
|
||||
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
|
||||
---
|
||||
import cloudDefendObj from './cloud_defend.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
|
||||
---
|
||||
import cloudExperimentsObj from './cloud_experiments.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
---
|
||||
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
|
||||
---
|
||||
import contentManagementObj from './content_management.devdocs.json';
|
||||
|
|
|
@ -5276,41 +5276,6 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.ControlGroupRuntimeState.defaultControlGrow",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "defaultControlGrow",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/controls/public/react_controls/control_group/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.ControlGroupRuntimeState.defaultControlWidth",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "defaultControlWidth",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlWidth",
|
||||
"text": "ControlWidth"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/controls/public/react_controls/control_group/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.ControlGroupRuntimeState.labelPosition",
|
||||
|
@ -6572,18 +6537,6 @@
|
|||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object>, \"unsavedChanges\"> & ",
|
||||
"PublishesControlDisplaySettings",
|
||||
" & { labelPosition: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<",
|
||||
"ControlStyle",
|
||||
">; } & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
@ -6655,7 +6608,7 @@
|
|||
"section": "def-common.ControlInputTransform",
|
||||
"text": "ControlInputTransform"
|
||||
},
|
||||
" | undefined; } | undefined) => void; lastUsedDataViewId$: ",
|
||||
" | undefined; } | undefined) => void; labelPosition: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
@ -6663,7 +6616,9 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<string | undefined>; }"
|
||||
"<",
|
||||
"ControlStyle",
|
||||
">; }"
|
||||
],
|
||||
"path": "src/plugins/controls/public/react_controls/control_group/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -6927,9 +6882,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & ",
|
||||
"PublishesControlDisplaySettings",
|
||||
" & Partial<",
|
||||
"<object> & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
@ -6997,7 +6950,31 @@
|
|||
},
|
||||
"<",
|
||||
"DefaultControlState",
|
||||
">; setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; } & Omit<",
|
||||
">; setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlWidth",
|
||||
"text": "ControlWidth"
|
||||
},
|
||||
" | undefined>; } & Omit<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 396 | 0 | 387 | 29 |
|
||||
| 394 | 0 | 385 | 28 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
---
|
||||
import customIntegrationsObj from './custom_integrations.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
---
|
||||
import dashboardObj from './dashboard.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality
|
|||
title: "dataQuality"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataQuality plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
|
||||
---
|
||||
import dataQualityObj from './data_quality.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
---
|
||||
import dataViewEditorObj from './data_view_editor.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
---
|
||||
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
---
|
||||
import dataViewsObj from './data_views.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
|
|||
title: "datasetQuality"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the datasetQuality plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
|
||||
---
|
||||
import datasetQualityObj from './dataset_quality.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -177,10 +177,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, aiops, remoteClusters, ml, graph, indexLifecycleManagement, mapsEms, osquery, securitySolution, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | fleet, apm, security, securitySolution | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | fleet, apm, security, securitySolution | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting, cases | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, @kbn/security-authorization-core, security, alerting, cases, @kbn/security-role-management-model | 8.8.0 |
|
||||
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, @kbn/core | 8.8.0 |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, presentationUtil, lens, dashboard, discover, graph, links | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security, @kbn/security-role-management-model | 8.8.0 |
|
||||
| <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | apm | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | mapsEms | 8.8.0 |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | savedObjectsTaggingOss | 8.8.0 |
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -428,6 +428,23 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
|
||||
|
||||
## @kbn/security-authorization-core
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 20 more | 8.8.0 |
|
||||
|
||||
|
||||
|
||||
## @kbn/security-role-management-model
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | [kibana_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts#:~:text=getKibanaFeatures), [kibana_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts#:~:text=getKibanaFeatures) | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [kibana_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts#:~:text=getElasticsearchFeatures) | 8.8.0 |
|
||||
|
||||
|
||||
|
||||
## @kbn/securitysolution-data-table
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
@ -1325,7 +1342,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
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.FeaturesPluginSetup.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)+ 24 more | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.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) | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.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="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 |
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -87,8 +87,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
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 |
|
||||
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.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)+ 27 more | 8.8.0 |
|
||||
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.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 |
|
||||
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getKibanaFeatures" text="getKibanaFeatures"/> | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.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), [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts#:~:text=getKibanaFeatures), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=getKibanaFeatures), [on_post_auth_interceptor.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 28 more | 8.8.0 |
|
||||
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.FeaturesPluginSetup.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures), [kibana_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts#:~:text=getElasticsearchFeatures) | 8.8.0 |
|
||||
| security | <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 |
|
||||
| security | <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 |
|
||||
| security | <DocLink id="kibLicensingPluginApi" section="def-server.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 |
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverShared
|
|||
title: "discoverShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discoverShared plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
|
||||
---
|
||||
import discoverSharedObj from './discover_shared.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
|
||||
---
|
||||
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
|
|||
title: "elasticAssistant"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the elasticAssistant plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
|
||||
---
|
||||
import elasticAssistantObj from './elastic_assistant.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
---
|
||||
import embeddableObj from './embeddable.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
---
|
||||
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entitiesDataAccess
|
|||
title: "entitiesDataAccess"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the entitiesDataAccess plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
|
||||
---
|
||||
import entitiesDataAccessObj from './entities_data_access.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entityManager
|
|||
title: "entityManager"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the entityManager plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
|
||||
---
|
||||
import entityManagerObj from './entity_manager.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esql
|
|||
title: "esql"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esql plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
|
||||
---
|
||||
import esqlObj from './esql.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid
|
|||
title: "esqlDataGrid"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esqlDataGrid plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
|
||||
---
|
||||
import esqlDataGridObj from './esql_data_grid.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
|
|||
title: "eventAnnotationListing"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotationListing plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
|
||||
---
|
||||
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
|
||||
|
|
|
@ -1450,7 +1450,7 @@
|
|||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; code?: string | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
||||
"(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; uuid?: string | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1470,7 +1470,7 @@
|
|||
"label": "IEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; code?: string | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; uuid?: string | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1485,7 +1485,7 @@
|
|||
"label": "IValidatedEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; code?: string | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined"
|
||||
"Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ id?: string | undefined; type?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; version?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; uuid?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; backfill?: Readonly<{ id?: string | undefined; start?: string | undefined; interval?: string | undefined; } & {}> | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; uuid?: string | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ id?: string | undefined; type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; duration?: string | number | undefined; severity?: string | number | undefined; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; provider?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
|
||||
---
|
||||
import exploratoryViewObj from './exploratory_view.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
---
|
||||
import expressionErrorObj from './expression_error.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
---
|
||||
import expressionGaugeObj from './expression_gauge.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
---
|
||||
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
---
|
||||
import expressionImageObj from './expression_image.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
---
|
||||
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
---
|
||||
import expressionMetricObj from './expression_metric.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
---
|
||||
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
---
|
||||
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
---
|
||||
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
---
|
||||
import expressionShapeObj from './expression_shape.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
---
|
||||
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
|
|
@ -2104,12 +2104,12 @@
|
|||
"path": "x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/app_authorization.ts"
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.ts"
|
||||
"path": "x-pack/plugins/security/server/authorization/app_authorization.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
|
@ -2127,129 +2127,133 @@
|
|||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/app_authorization.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "spaces",
|
||||
"path": "x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/public/management/roles/__fixtures__/kibana_privileges.ts"
|
||||
"plugin": "@kbn/security-role-management-model",
|
||||
"path": "x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-role-management-model",
|
||||
"path": "x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-authorization-core",
|
||||
"path": "x-pack/packages/security/authorization_core/src/privileges/privileges.test.ts"
|
||||
}
|
||||
],
|
||||
"children": [],
|
||||
|
@ -2285,6 +2289,10 @@
|
|||
{
|
||||
"plugin": "security",
|
||||
"path": "x-pack/plugins/security/server/authorization/authorization_service.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/security-role-management-model",
|
||||
"path": "x-pack/packages/security/role_management_model/src/__fixtures__/kibana_privileges.ts"
|
||||
}
|
||||
],
|
||||
"children": [],
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
---
|
||||
import featuresObj from './features.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldsMetadata
|
|||
title: "fieldsMetadata"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fieldsMetadata plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
|
||||
---
|
||||
import fieldsMetadataObj from './fields_metadata.devdocs.json';
|
||||
|
|
|
@ -981,6 +981,20 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.FindFileStructureResponse.document_type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "document_type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.FindFileStructureResponse.field_stats",
|
||||
|
@ -1295,6 +1309,26 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.FindFileStructureResponse.ingest_pipeline",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "ingest_pipeline",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "fileUpload",
|
||||
"scope": "common",
|
||||
"docId": "kibFileUploadPluginApi",
|
||||
"section": "def-common.IngestPipeline",
|
||||
"text": "IngestPipeline"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.FindFileStructureResponse.quote",
|
||||
|
@ -1517,6 +1551,34 @@
|
|||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.IngestPipeline.isManaged",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "isManaged",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-common.IngestPipeline.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis)
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 84 | 0 | 84 | 8 |
|
||||
| 88 | 0 | 88 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
|
||||
---
|
||||
import filesManagementObj from './files_management.devdocs.json';
|
||||
|
|
|
@ -27941,7 +27941,7 @@
|
|||
"label": "RegistrySearchResult",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ type?: \"input\" | \"integration\" | undefined; version: string; name: string; title: string; description: string; path: string; internal?: boolean | undefined; download: string; icons?: (",
|
||||
"{ type?: \"input\" | \"integration\" | undefined; version: string; name: string; title: string; description: string; internal?: boolean | undefined; path: string; download: string; icons?: (",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
---
|
||||
import fleetObj from './fleet.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
|
||||
---
|
||||
import imageEmbeddableObj from './image_embeddable.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
---
|
||||
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';
|
||||
|
|
|
@ -2405,6 +2405,145 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "IndexModule",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.number_of_shards",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "number_of_shards",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.codec",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "codec",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.routing_partition_size",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "routing_partition_size",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.refresh_interval",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "refresh_interval",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.load_fixed_bitset_filters_eagerly",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "load_fixed_bitset_filters_eagerly",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.shard",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "shard",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ check_on_startup: boolean | \"checksum\"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.number_of_replicas",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "number_of_replicas",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.auto_expand_replicas",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "auto_expand_replicas",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | false"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.lifecycle",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "lifecycle",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"LifecycleModule"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexModule.routing",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "routing",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ allocation: { enable: \"none\" | \"all\" | \"primaries\" | \"new_primaries\"; }; rebalance: { enable: \"none\" | \"all\" | \"primaries\" | \"replicas\"; }; }"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexManagement",
|
||||
"id": "def-common.IndexSettings",
|
||||
|
@ -2424,7 +2563,15 @@
|
|||
"label": "index",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<IndexModule> | undefined"
|
||||
"Partial<",
|
||||
{
|
||||
"pluginId": "indexManagement",
|
||||
"scope": "common",
|
||||
"docId": "kibIndexManagementPluginApi",
|
||||
"section": "def-common.IndexModule",
|
||||
"text": "IndexModule"
|
||||
},
|
||||
"> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/index_management/common/types/indices.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 227 | 0 | 222 | 1 |
|
||||
| 238 | 0 | 233 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/inference
|
|||
title: "inference"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the inference plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
|
||||
---
|
||||
import inferenceObj from './inference.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
|
||||
Contact [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai-infra) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
---
|
||||
import infraObj from './infra.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
|
|||
title: "ingestPipelines"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the ingestPipelines plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
|
||||
---
|
||||
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
---
|
||||
import inspectorObj from './inspector.devdocs.json';
|
||||
|
|
|
@ -188,7 +188,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }; }"
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }; }"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/build_integration/build_integration.ts",
|
||||
"deprecated": false,
|
||||
|
@ -353,7 +353,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }"
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
|
@ -497,7 +497,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }"
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
|
@ -667,6 +667,23 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "integrationAssistant",
|
||||
"id": "def-common.SamplesFormat",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "SamplesFormat",
|
||||
"description": [
|
||||
"\nFormat of the provided log samples."
|
||||
],
|
||||
"signature": [
|
||||
"{ name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [
|
||||
|
@ -742,7 +759,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; samplesFormat: Zod.ZodObject<{ name: Zod.ZodEnum<[\"ndjson\", \"json\"]>; multiline: Zod.ZodOptional<Zod.ZodBoolean>; json_path: Zod.ZodOptional<Zod.ZodArray<Zod.ZodString, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -758,7 +775,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -774,7 +791,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }>, \"many\">; logo: Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }>, \"many\">; logo: Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -790,7 +807,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -806,7 +823,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { integration: { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { integration: { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -822,7 +839,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }; }, { integration: { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }; }, { integration: { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -838,7 +855,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }; }>"
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/build_integration/build_integration.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1297,7 +1314,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; samplesFormat: Zod.ZodObject<{ name: Zod.ZodEnum<[\"ndjson\", \"json\"]>; multiline: Zod.ZodOptional<Zod.ZodBoolean>; json_path: Zod.ZodOptional<Zod.ZodArray<Zod.ZodString, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1313,7 +1330,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1329,7 +1346,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }>"
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1627,7 +1644,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }>; docs: Zod.ZodArray<Zod.ZodObject<{}, \"passthrough\", Zod.ZodTypeAny, Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">, Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">>, \"many\">; samplesFormat: Zod.ZodObject<{ name: Zod.ZodEnum<[\"ndjson\", \"json\"]>; multiline: Zod.ZodOptional<Zod.ZodBoolean>; json_path: Zod.ZodOptional<Zod.ZodArray<Zod.ZodString, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1643,7 +1660,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }, { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1659,7 +1676,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }>, \"many\">; logo: Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }>, \"many\">; logo: Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1675,7 +1692,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
"[] | undefined; }; docs: Zod.objectOutputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }, { name: string; title: string; description: string; dataStreams: { name: string; title: string; description: string; inputTypes: (\"kafka\" | \"aws-cloudwatch\" | \"aws-s3\" | \"azure-blob-storage\" | \"azure-eventhub\" | \"cel\" | \"cloudfoundry\" | \"filestream\" | \"gcp-pubsub\" | \"gcs\" | \"http-endpoint\" | \"journald\" | \"tcp\" | \"udp\")[]; rawSamples: string[]; pipeline: { processors: ",
|
||||
{
|
||||
"pluginId": "integrationAssistant",
|
||||
"scope": "common",
|
||||
|
@ -1691,7 +1708,7 @@
|
|||
"section": "def-common.ESProcessorItem",
|
||||
"text": "ESProcessorItem"
|
||||
},
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; }[]; logo?: string | undefined; }>"
|
||||
"[] | undefined; }; docs: Zod.objectInputType<{}, Zod.ZodTypeAny, \"passthrough\">[]; samplesFormat: { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }; }[]; logo?: string | undefined; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
|
@ -2030,6 +2047,21 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "integrationAssistant",
|
||||
"id": "def-common.SamplesFormat",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "SamplesFormat",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Zod.ZodObject<{ name: Zod.ZodEnum<[\"ndjson\", \"json\"]>; multiline: Zod.ZodOptional<Zod.ZodBoolean>; json_path: Zod.ZodOptional<Zod.ZodArray<Zod.ZodString, \"many\">>; }, \"strip\", Zod.ZodTypeAny, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }, { name: \"json\" | \"ndjson\"; multiline?: boolean | undefined; json_path?: string[] | undefined; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/integration_assistant/common/api/model/common_attributes.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/integrationAssistant
|
|||
title: "integrationAssistant"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the integrationAssistant plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
|
||||
---
|
||||
import integrationAssistantObj from './integration_assistant.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/security-scalability](https://github.com/orgs/elastic/teams/se
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 47 | 0 | 40 | 3 |
|
||||
| 49 | 0 | 41 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
---
|
||||
import interactiveSetupObj from './interactive_setup.devdocs.json';
|
||||
|
|
|
@ -494,10 +494,10 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.created",
|
||||
"id": "def-public.InvestigateWidget.createdAt",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "created",
|
||||
"label": "createdAt",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -505,10 +505,21 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.last_updated",
|
||||
"type": "number",
|
||||
"id": "def-public.InvestigateWidget.createdBy",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "last_updated",
|
||||
"label": "createdBy",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.title",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "title",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -525,26 +536,6 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.user",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "user",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/core-security-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCoreSecurityCommonPluginApi",
|
||||
"section": "def-common.AuthenticatedUser",
|
||||
"text": "AuthenticatedUser"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.parameters",
|
||||
|
@ -573,17 +564,6 @@
|
|||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigateWidget.title",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "title",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -886,7 +866,7 @@
|
|||
"section": "def-common.AuthenticatedUser",
|
||||
"text": "AuthenticatedUser"
|
||||
},
|
||||
"; investigationData?: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; } | undefined; }) => ",
|
||||
"; investigationData?: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]; } | undefined; }) => ",
|
||||
"UseInvestigationApi"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/public/types.ts",
|
||||
|
@ -932,7 +912,7 @@
|
|||
"label": "investigationData",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; } | undefined"
|
||||
"{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]; } | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/public/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1263,10 +1243,10 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.created",
|
||||
"id": "def-common.InvestigateWidget.createdAt",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "created",
|
||||
"label": "createdAt",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1274,10 +1254,21 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.last_updated",
|
||||
"type": "number",
|
||||
"id": "def-common.InvestigateWidget.createdBy",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "last_updated",
|
||||
"label": "createdBy",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.title",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "title",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1294,26 +1285,6 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.user",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "user",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/core-security-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCoreSecurityCommonPluginApi",
|
||||
"section": "def-common.AuthenticatedUser",
|
||||
"text": "AuthenticatedUser"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.parameters",
|
||||
|
@ -1342,17 +1313,6 @@
|
|||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigateWidget.title",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "title",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigate
|
|||
title: "investigate"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the investigate plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate']
|
||||
---
|
||||
import investigateObj from './investigate.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 94 | 0 | 94 | 5 |
|
||||
| 92 | 0 | 92 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -50,33 +50,77 @@
|
|||
"label": "InvestigateAppServerRouteRepository",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ \"DELETE /api/observability/investigations/{id}/notes/{noteId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{id}/notes/{noteId} 2023-10-31\"; params?: ",
|
||||
"{ \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { investigationId: string; }; }; }) => Promise<({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"DELETE /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; itemId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { investigationId: string; itemId: string; }; }; }) => Promise<void>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"POST /api/observability/investigations/{investigationId}/items 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{investigationId}/items 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; body: ",
|
||||
"TypeC",
|
||||
"<{ title: ",
|
||||
"StringC",
|
||||
"; type: ",
|
||||
"LiteralC",
|
||||
"<\"esql\">; params: ",
|
||||
"TypeC",
|
||||
"<{ esql: ",
|
||||
"StringC",
|
||||
"; suggestion: ",
|
||||
"AnyC",
|
||||
"; }>; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { investigationId: string; }; body: { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; }; }; }) => Promise<{ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"DELETE /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; noteId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; noteId: string; }; }; }) => Promise<void>; } & ",
|
||||
" & { params: { path: { investigationId: string; noteId: string; }; }; }) => Promise<void>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"GET /api/observability/investigations/{id}/notes 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{id}/notes 2023-10-31\"; params?: ",
|
||||
"; \"GET /api/observability/investigations/{investigationId}/notes 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId}/notes 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }[]>; } & ",
|
||||
" & { params: { path: { investigationId: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }[]>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"POST /api/observability/investigations/{id}/notes 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{id}/notes 2023-10-31\"; params?: ",
|
||||
"; \"POST /api/observability/investigations/{investigationId}/notes 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{investigationId}/notes 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; body: ",
|
||||
"TypeC",
|
||||
|
@ -84,27 +128,27 @@
|
|||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; body: { content: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }>; } & ",
|
||||
" & { params: { path: { investigationId: string; }; body: { content: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"DELETE /api/observability/investigations/{id} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{id} 2023-10-31\"; params?: ",
|
||||
"; \"DELETE /api/observability/investigations/{investigationId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<void>; } & ",
|
||||
" & { params: { path: { investigationId: string; }; }; }) => Promise<void>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"GET /api/observability/investigations/{id} 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{id} 2023-10-31\"; params?: ",
|
||||
"; \"GET /api/observability/investigations/{investigationId} 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"<{ investigationId: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }>; } & ",
|
||||
" & { params: { path: { investigationId: string; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"GET /api/observability/investigations 2023-10-31\": { endpoint: \"GET /api/observability/investigations 2023-10-31\"; params?: ",
|
||||
"PartialC",
|
||||
|
@ -118,7 +162,7 @@
|
|||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params?: { query?: { alertId?: string | undefined; page?: string | undefined; perPage?: string | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }[]; }>; } & ",
|
||||
" & { params?: { query?: { alertId?: string | undefined; page?: string | undefined; perPage?: string | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]; }[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"POST /api/observability/investigations 2023-10-31\": { endpoint: \"POST /api/observability/investigations 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
|
@ -150,7 +194,7 @@
|
|||
"LiteralC",
|
||||
"<\"blank\">; }>]>; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { body: { id: string; title: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }>; } & ",
|
||||
" & { params: { body: { id: string; title: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: \"esql\"; params: { esql: string; suggestion: any; }; })[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; }"
|
||||
],
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigateApp
|
|||
title: "investigateApp"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the investigateApp plugin
|
||||
date: 2024-08-21
|
||||
date: 2024-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
|
||||
---
|
||||
import investigateAppObj from './investigate_app.devdocs.json';
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue