[api-docs] 2024-05-03 Daily api_docs build (#182539)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/695
This commit is contained in:
Kibana Machine 2024-05-03 00:55:02 -04:00 committed by GitHub
parent c909608f5f
commit af580c9f92
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
837 changed files with 6562 additions and 4108 deletions

View file

@ -626,39 +626,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -764,7 +732,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",

View file

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

View file

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

View file

@ -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-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

View file

@ -664,7 +664,7 @@
"signature": [
"{ useFieldStatsTrigger: () => { renderOption: ((option: ",
"EuiComboBoxOptionOption",
"<string>, searchValue: string, OPTION_CONTENT_CLASSNAME: string) => React.ReactNode) | undefined; closeFlyout: () => void; }; FieldStatsFlyoutProvider: React.FC<{ dataView: ",
"<string>, searchValue: string, OPTION_CONTENT_CLASSNAME: string) => React.ReactNode) | undefined; closeFlyout: () => void; }; FieldStatsFlyoutProvider: React.FC<React.PropsWithChildren<{ dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -688,7 +688,7 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; dslQuery?: object | undefined; }>; } | undefined"
" | undefined; dslQuery?: object | undefined; }>>; } | undefined"
],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

View file

@ -2041,7 +2041,7 @@
},
"<Params>"
],
"path": "x-pack/plugins/alerting/server/rules_client/methods/find.ts",
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2052,7 +2052,7 @@
"tags": [],
"label": "page",
"description": [],
"path": "x-pack/plugins/alerting/server/rules_client/methods/find.ts",
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2063,7 +2063,7 @@
"tags": [],
"label": "perPage",
"description": [],
"path": "x-pack/plugins/alerting/server/rules_client/methods/find.ts",
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2074,7 +2074,7 @@
"tags": [],
"label": "total",
"description": [],
"path": "x-pack/plugins/alerting/server/rules_client/methods/find.ts",
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2095,7 +2095,7 @@
},
"<Params>[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/methods/find.ts",
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
"deprecated": false,
"trackAdoption": false
}
@ -3234,7 +3234,8 @@
"label": "executionStatus",
"description": [],
"signature": [
"RuleExecutionStatus"
"RuleExecutionStatus",
" | undefined"
],
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
@ -3248,7 +3249,7 @@
"label": "monitoring",
"description": [],
"signature": [
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: Readonly<{ warning?: \"execute\" | \"unknown\" | \"license\" | \"read\" | \"decrypt\" | \"timeout\" | \"disabled\" | \"validate\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ active?: number | null | undefined; new?: number | null | undefined; recovered?: 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\" | \"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,
@ -3262,7 +3263,7 @@
"label": "snoozeSchedule",
"description": [],
"signature": [
"Readonly<{ id?: string | undefined; skipRecurrences?: string[] | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 6 | 5 | 4 | 3 | undefined; until?: string | undefined; wkst?: \"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\" | undefined; byweekday?: (string | number)[] | undefined; bymonth?: number[] | undefined; bysetpos?: number[] | undefined; bymonthday?: number[] | undefined; byyearday?: number[] | undefined; byweekno?: number[] | undefined; byhour?: number[] | undefined; byminute?: number[] | undefined; bysecond?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>[] | undefined"
"Readonly<{ id?: string | undefined; skipRecurrences?: string[] | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 6 | 5 | 4 | 3 | undefined; until?: string | undefined; byweekday?: (string | number)[] | undefined; bymonthday?: number[] | undefined; bymonth?: number[] | undefined; wkst?: \"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\" | undefined; bysetpos?: number[] | undefined; byyearday?: number[] | undefined; byweekno?: number[] | undefined; byhour?: number[] | undefined; byminute?: number[] | undefined; bysecond?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>[] | undefined"
],
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
@ -3304,7 +3305,7 @@
"label": "lastRun",
"description": [],
"signature": [
"Readonly<{ warning?: \"execute\" | \"unknown\" | \"license\" | \"read\" | \"decrypt\" | \"timeout\" | \"disabled\" | \"validate\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ active?: number | null | undefined; new?: number | null | undefined; recovered?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined"
"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"
],
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
@ -3376,6 +3377,20 @@
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.Rule.legacyId",
"type": "CompoundType",
"tags": [],
"label": "legacyId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -3790,22 +3805,6 @@
"plugin": "synthetics",
"path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts"
},
{
"plugin": "uptime",
"path": "x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/common.ts"
},
{
"plugin": "uptime",
"path": "x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/status_check.ts"
},
{
"plugin": "uptime",
"path": "x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/tls.ts"
},
{
"plugin": "uptime",
"path": "x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/duration_anomaly.ts"
},
{
"plugin": "ruleRegistry",
"path": "x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts"
@ -4849,7 +4848,7 @@
"label": "AlertingRulesConfig",
"description": [],
"signature": [
"Pick<Readonly<{ overwriteProducer?: \"siem\" | \"observability\" | \"stackAlerts\" | undefined; } & { run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; maxScheduledPerMinute: number; }>, \"minimumScheduleInterval\" | \"maxScheduledPerMinute\"> & { isUsingSecurity: boolean; }"
"Pick<Readonly<{ overwriteProducer?: \"siem\" | \"observability\" | \"stackAlerts\" | undefined; } & { minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; maxScheduledPerMinute: number; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\" | \"maxScheduledPerMinute\"> & { isUsingSecurity: boolean; }"
],
"path": "x-pack/plugins/alerting/server/config.ts",
"deprecated": false,
@ -4902,7 +4901,7 @@
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
"; }> | undefined; } & { meta: Record<string, any>; }>[]; }> | undefined; timeframe?: Readonly<{} & { days: (2 | 1 | 7 | 6 | 5 | 4 | 3)[]; hours: Readonly<{} & { start: string; end: string; }>; timezone: string; }> | undefined; } & {}> | undefined; uuid?: string | undefined; useAlertDataForTemplate?: boolean | undefined; } & { params: Record<string, any>; id: string; group: string; }> | Readonly<{ actionTypeId?: string | undefined; uuid?: string | undefined; } & { params: Record<string, any>; id: string; }>)[]; operation: \"add\" | \"set\"; field: \"actions\"; }> | Readonly<{} & { value: Readonly<{} & { interval: string; }>; operation: \"set\"; field: \"schedule\"; }> | Readonly<{} & { value: string | null; operation: \"set\"; field: \"throttle\"; }> | Readonly<{} & { value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; operation: \"set\"; field: \"notifyWhen\"; }> | Readonly<{} & { value: Readonly<{ id?: string | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 3 | undefined; until?: string | undefined; byweekday?: string[] | undefined; bymonth?: number[] | undefined; bymonthday?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>; operation: \"set\"; field: \"snoozeSchedule\"; }> | Readonly<{ value?: string[] | undefined; } & { operation: \"delete\"; field: \"snoozeSchedule\"; }> | Readonly<{} & { operation: \"set\"; field: \"apiKey\"; }>"
"; }> | undefined; } & { meta: Record<string, any>; }>[]; }> | undefined; timeframe?: Readonly<{} & { days: (2 | 1 | 7 | 6 | 5 | 4 | 3)[]; hours: Readonly<{} & { start: string; end: string; }>; timezone: string; }> | undefined; } & {}> | undefined; uuid?: string | undefined; useAlertDataForTemplate?: boolean | undefined; } & { params: Record<string, any>; id: string; group: string; }> | Readonly<{ actionTypeId?: string | undefined; uuid?: string | undefined; } & { params: Record<string, any>; id: string; }>)[]; operation: \"add\" | \"set\"; field: \"actions\"; }> | Readonly<{} & { value: Readonly<{} & { interval: string; }>; operation: \"set\"; field: \"schedule\"; }> | Readonly<{} & { value: string | null; operation: \"set\"; field: \"throttle\"; }> | Readonly<{} & { value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; operation: \"set\"; field: \"notifyWhen\"; }> | Readonly<{} & { value: Readonly<{ id?: string | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 3 | undefined; until?: string | undefined; byweekday?: string[] | undefined; bymonthday?: number[] | undefined; bymonth?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>; operation: \"set\"; field: \"snoozeSchedule\"; }> | Readonly<{ value?: string[] | undefined; } & { operation: \"delete\"; field: \"snoozeSchedule\"; }> | Readonly<{} & { operation: \"set\"; field: \"apiKey\"; }>"
],
"path": "x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/types/bulk_edit_rules_options.ts",
"deprecated": false,
@ -5210,9 +5209,7 @@
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params: ",
"GetParams",
") => Promise<",
" = never>(params: Readonly<{ includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; } & { id: string; }>) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
@ -5242,9 +5239,7 @@
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params?: ",
"FindParams",
" | undefined) => Promise<",
" = never>(params?: Readonly<{ options?: Readonly<{ page?: number | undefined; filter?: string | Record<string, any> | undefined; search?: string | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; hasReference?: Readonly<{} & { id: string; type: string; }> | undefined; fields?: string[] | undefined; filterConsumers?: string[] | undefined; } & {}> | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; featureIds?: string[] | undefined; } & {}> | undefined) => Promise<",
{
"pluginId": "alerting",
"scope": "server",
@ -5262,7 +5257,7 @@
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(args_0: string, args_1: { newId?: string | undefined; }) => Promise<",
" = never>(params: Readonly<{ newId?: string | undefined; } & { id: string; }>) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
@ -5346,25 +5341,11 @@
"BulkEditOptions",
"<Params>) => Promise<",
"BulkEditResult",
"<Params>>; bulkEnableRules: (options: ",
"BulkOptions",
") => Promise<{ errors: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]; rules: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.Rule",
"text": "Rule"
},
"<Record<string, any>>[]; total: number; taskIdsFailedToBeEnabled: string[]; }>; bulkDisableRules: (options: Readonly<{ filter?: string | undefined; ids?: string[] | undefined; untrack?: boolean | undefined; } & {}>) => Promise<",
"<Params>>; bulkEnableRules: (params: ",
"BulkEnableRulesParams",
") => Promise<",
"BulkEnableRulesResult",
"<Record<string, any>>>; bulkDisableRules: (options: Readonly<{ filter?: string | undefined; ids?: string[] | undefined; untrack?: boolean | undefined; } & {}>) => Promise<",
"BulkDisableRulesResult",
"<Record<string, any>>>; updateApiKey: (options: { id: string; }) => Promise<void>; enable: (options: { id: string; }) => Promise<void>; disable: (options: { id: string; untrack?: boolean | undefined; }) => Promise<void>; snooze: (options: ",
"SnoozeRuleOptions",
@ -5386,9 +5367,9 @@
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">, \"id\" | \"snoozeSchedule\">; version?: string | undefined; }) => Promise<void>; unmuteAll: (options: { id: string; }) => Promise<void>; muteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; unmuteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; bulkUntrackAlerts: (options: Readonly<{ indices?: string[] | undefined; alertUuids?: string[] | undefined; query?: any[] | undefined; featureIds?: string[] | undefined; } & { isUsingQuery: boolean; }>) => Promise<void>; runSoon: (options: { id: string; }) => Promise<string | undefined>; listRuleTypes: () => Promise<Set<",
">, \"id\" | \"snoozeSchedule\">; version?: string | undefined; }) => Promise<void>; unmuteAll: (options: { id: string; }) => Promise<void>; muteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; unmuteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; bulkUntrackAlerts: (options: Readonly<{ indices?: string[] | undefined; featureIds?: string[] | undefined; alertUuids?: string[] | undefined; query?: any[] | undefined; } & { isUsingQuery: boolean; }>) => Promise<void>; runSoon: (options: { id: string; }) => Promise<string | undefined>; listRuleTypes: () => Promise<Set<",
"RegistryAlertTypeWithAuth",
">>; scheduleBackfill: (params: Readonly<{ end?: string | undefined; } & { start: string; ruleId: string; }>[]) => Promise<(Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; runAt: string; }>[]; createdAt: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; duration: string; }> | Readonly<{} & { error: Readonly<{} & { error: string; message: string; }>; }>)[]>; getBackfill: (id: string) => Promise<Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; runAt: string; }>[]; createdAt: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; duration: string; }>>; findBackfill: (params: Readonly<{ start?: string | undefined; end?: string | undefined; ruleIds?: string | undefined; sortField?: \"start\" | \"createdAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; } & { page: number; perPage: number; }>) => Promise<Readonly<{} & { page: number; perPage: number; total: number; data: Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; runAt: string; }>[]; createdAt: string; status: \"error\" | \"running\" | \"pending\" | \"timeout\" | \"complete\"; duration: string; }>[]; }>>; deleteBackfill: (id: string) => Promise<{}>; getSpaceId: () => string | undefined; getAuthorization: () => ",
">>; scheduleBackfill: (params: Readonly<{ end?: string | undefined; } & { start: string; ruleId: string; }>[]) => Promise<(Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }> | Readonly<{} & { error: Readonly<{} & { error: string; message: string; }>; }>)[]>; getBackfill: (id: string) => Promise<Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }>>; findBackfill: (params: Readonly<{ start?: string | undefined; end?: string | undefined; sortField?: \"start\" | \"createdAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; ruleIds?: string | undefined; } & { page: number; perPage: number; }>) => Promise<Readonly<{} & { page: number; perPage: number; total: number; data: Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }>[]; }>>; deleteBackfill: (id: string) => Promise<{}>; getSpaceId: () => string | undefined; getAuthorization: () => ",
{
"pluginId": "alerting",
"scope": "server",
@ -5398,10 +5379,10 @@
},
"; getAuditLogger: () => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AuditLogger",
"pluginId": "@kbn/core-security-server",
"scope": "common",
"docId": "kibKbnCoreSecurityServerPluginApi",
"section": "def-common.AuditLogger",
"text": "AuditLogger"
},
" | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<Readonly<{} & { page: number; perPage: number; total: number; data: string[]; }>>; getScheduleFrequency: () => Promise<Readonly<{} & { totalScheduledPerMinute: number; remainingSchedulesPerMinute: number; }>>; getAlertFromRaw: (params: ",
@ -8937,7 +8918,7 @@
"label": "status",
"description": [],
"signature": [
"\"unknown\" | \"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\""
"\"unknown\" | \"ok\" | \"error\" | \"pending\" | \"active\" | \"warning\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
@ -11398,7 +11379,7 @@
"label": "ReservedActionGroups",
"description": [],
"signature": [
"\"recovered\" | RecoveryActionGroupId"
"RecoveryActionGroupId | \"recovered\""
],
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
"deprecated": false,
@ -11485,7 +11466,7 @@
"signature": [
"Omit<",
"Options",
", \"dtstart\" | \"until\" | \"wkst\" | \"byweekday\"> & { dtstart: string; byweekday?: (string | number)[] | undefined; wkst?: ",
", \"dtstart\" | \"until\" | \"byweekday\" | \"wkst\"> & { dtstart: string; byweekday?: (string | number)[] | undefined; wkst?: ",
{
"pluginId": "@kbn/rrule",
"scope": "common",
@ -11640,7 +11621,7 @@
"label": "RuleExecutionStatuses",
"description": [],
"signature": [
"\"unknown\" | \"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\""
"\"unknown\" | \"ok\" | \"error\" | \"pending\" | \"active\" | \"warning\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
@ -11865,7 +11846,7 @@
"signature": [
"Pick<",
"AggregateOptions",
", \"search\" | \"filter\"> & { after?: ",
", \"filter\" | \"search\"> & { after?: ",
"AggregationsCompositeAggregateKey",
" | undefined; maxTags?: number | undefined; }"
],

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2024-04-29
date: 2024-05-03
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 |
|-------------------|-----------|------------------------|-----------------|
| 860 | 1 | 828 | 55 |
| 861 | 1 | 829 | 54 |
## Client

File diff suppressed because one or more lines are too long

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 29 | 0 | 29 | 125 |
| 29 | 0 | 29 | 122 |
## Client

View file

@ -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-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

View file

@ -11,7 +11,7 @@
"tags": [],
"label": "AssetManagerPublicPluginSetup",
"description": [],
"path": "x-pack/plugins/asset_manager/public/types.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -25,7 +25,7 @@
"signature": [
"IPublicAssetsClient"
],
"path": "x-pack/plugins/asset_manager/public/types.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
@ -39,7 +39,7 @@
"tags": [],
"label": "AssetManagerPublicPluginStart",
"description": [],
"path": "x-pack/plugins/asset_manager/public/types.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -53,7 +53,7 @@
"signature": [
"IPublicAssetsClient"
],
"path": "x-pack/plugins/asset_manager/public/types.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
@ -73,7 +73,7 @@
"signature": [
"\"assetManager\""
],
"path": "x-pack/plugins/asset_manager/public/index.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
@ -97,7 +97,7 @@
"signature": [
"{ readonly alphaEnabled?: boolean | undefined; readonly sourceIndices: Readonly<{} & { logs: string; }>; }"
],
"path": "x-pack/plugins/asset_manager/common/config.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/common/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
@ -112,7 +112,7 @@
"signature": [
"{ baseDateTime?: string | number | undefined; excludeEans?: string[] | undefined; refresh?: boolean | \"wait_for\" | undefined; } | null"
],
"path": "x-pack/plugins/asset_manager/server/routes/sample_assets.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/server/routes/sample_assets.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
@ -131,7 +131,7 @@
"AssetClient",
"; } | undefined"
],
"path": "x-pack/plugins/asset_manager/server/plugin.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "setup",
@ -147,7 +147,7 @@
"signature": [
"{} | undefined"
],
"path": "x-pack/plugins/asset_manager/server/plugin.ts",
"path": "x-pack/plugins/observability_solution/asset_manager/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",

View file

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

View file

@ -0,0 +1,59 @@
{
"id": "assetsDataAccess",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "assetsDataAccess",
"id": "def-server.AssetsDataAccessPluginStart",
"type": "Type",
"tags": [],
"label": "AssetsDataAccessPluginStart",
"description": [],
"signature": [
"{ services: {}; }"
],
"path": "x-pack/plugins/observability_solution/assets_data_access/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "assetsDataAccess",
"id": "def-server.AssetsDataAccessPluginSetup",
"type": "Type",
"tags": [],
"label": "AssetsDataAccessPluginSetup",
"description": [],
"signature": [
"void"
],
"path": "x-pack/plugins/observability_solution/assets_data_access/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

View file

@ -0,0 +1,33 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibAssetsDataAccessPluginApi
slug: /kibana-dev-docs/api/assetsDataAccess
title: "assetsDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the assetsDataAccess plugin
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetsDataAccess']
---
import assetsDataAccessObj from './assets_data_access.devdocs.json';
Contact [@elastic/obs-knowledge-team](https://github.com/orgs/elastic/teams/obs-knowledge-team) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2 | 0 | 2 | 0 |
## Server
### Start
<DocDefinitionList data={[assetsDataAccessObj.server.start]}/>
### Consts, variables and types
<DocDefinitionList data={assetsDataAccessObj.server.misc}/>

View file

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

View file

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

View file

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

View file

@ -683,9 +683,9 @@
"GetCasesProps",
") => React.ReactElement<",
"GetCasesProps",
", string | React.JSXElementConstructor<any>>; getCasesContext: () => React.FC<",
", string | React.JSXElementConstructor<any>>; getCasesContext: () => React.FC<React.PropsWithChildren<",
"GetCasesContextProps",
">; getAllCasesSelectorModal: (props: ",
">>; getAllCasesSelectorModal: (props: ",
{
"pluginId": "cases",
"scope": "public",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

View file

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

View file

@ -235,7 +235,7 @@
"\nA React component that provides a pre-wired `React.Context` which connects components to Cloud services."
],
"signature": [
"React.FunctionComponent<{}>"
"React.FunctionComponent<{ children?: React.ReactNode; }>"
],
"path": "x-pack/plugins/cloud/public/types.ts",
"deprecated": false,

View file

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

View file

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

View file

@ -739,7 +739,7 @@
"label": "CloudDefendStatusCode",
"description": [],
"signature": [
"\"indexed\" | \"unprivileged\" | \"indexing\" | \"index-timeout\" | \"not-deployed\" | \"not-installed\""
"\"unprivileged\" | \"indexed\" | \"indexing\" | \"index-timeout\" | \"not-deployed\" | \"not-installed\""
],
"path": "x-pack/plugins/cloud_defend/common/v1.ts",
"deprecated": false,

View file

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

View file

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

View file

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

View file

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

View file

@ -490,7 +490,7 @@
"label": "ContentClientProvider",
"description": [],
"signature": [
"({ contentClient, children, }: React.PropsWithChildren<{ contentClient: ",
"({ contentClient, children }: React.PropsWithChildren<React.PropsWithChildren<{ contentClient: ",
{
"pluginId": "contentManagement",
"scope": "public",
@ -498,7 +498,7 @@
"section": "def-public.ContentClient",
"text": "ContentClient"
},
"; }>) => JSX.Element"
"; }>>) => JSX.Element"
],
"path": "src/plugins/content_management/public/content_client/content_client_context.tsx",
"deprecated": false,
@ -509,10 +509,10 @@
"id": "def-public.ContentClientProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n contentClient,\n children,\n}",
"label": "{ contentClient, children }",
"description": [],
"signature": [
"React.PropsWithChildren<{ contentClient: ",
"React.PropsWithChildren<React.PropsWithChildren<{ contentClient: ",
{
"pluginId": "contentManagement",
"scope": "public",
@ -520,7 +520,7 @@
"section": "def-public.ContentClient",
"text": "ContentClient"
},
"; }>"
"; }>>"
],
"path": "src/plugins/content_management/public/content_client/content_client_context.tsx",
"deprecated": false,
@ -2916,7 +2916,7 @@
"label": "ProcedureName",
"description": [],
"signature": [
"\"search\" | \"create\" | \"update\" | \"get\" | \"delete\" | \"bulkGet\" | \"mSearch\""
"\"create\" | \"update\" | \"get\" | \"delete\" | \"search\" | \"bulkGet\" | \"mSearch\""
],
"path": "src/plugins/content_management/common/rpc/constants.ts",
"deprecated": false,

View file

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

View file

@ -4725,7 +4725,7 @@
"label": "chainingSystem",
"description": [],
"signature": [
"\"NONE\" | \"HIERARCHICAL\""
"\"HIERARCHICAL\" | \"NONE\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -7005,7 +7005,7 @@
"label": "chainingSystem",
"description": [],
"signature": [
"\"NONE\" | \"HIERARCHICAL\""
"\"HIERARCHICAL\" | \"NONE\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,

View file

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

View file

@ -253,7 +253,7 @@
"label": "ContextProvider",
"description": [],
"signature": [
"React.FunctionComponent<{}>"
"React.FunctionComponent<{ children?: React.ReactNode; }>"
],
"path": "src/plugins/custom_integrations/public/types.ts",
"deprecated": false,

View file

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

View file

@ -393,6 +393,54 @@
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.registerDashboardPanelPlacementSetting",
"type": "Function",
"tags": [],
"label": "registerDashboardPanelPlacementSetting",
"description": [],
"signature": [
"(embeddableType: string, getPanelPlacementSettings: GetPanelPlacementSettings<object>) => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_panel_placement_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.registerDashboardPanelPlacementSetting.$1",
"type": "string",
"tags": [],
"label": "embeddableType",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_panel_placement_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-public.registerDashboardPanelPlacementSetting.$2",
"type": "Function",
"tags": [],
"label": "getPanelPlacementSettings",
"description": [],
"signature": [
"GetPanelPlacementSettings<object>"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_panel_placement_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
@ -619,10 +667,10 @@
"signature": [
"((dashboardId?: string | undefined) => ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableAppContext",
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableAppContext",
"text": "EmbeddableAppContext"
},
") | undefined"
@ -678,7 +726,20 @@
"initialIsOpen": false
}
],
"enums": [],
"enums": [
{
"parentPluginId": "dashboard",
"id": "def-public.PanelPlacementStrategy",
"type": "Enum",
"tags": [],
"label": "PanelPlacementStrategy",
"description": [],
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "dashboard",
@ -2187,7 +2248,7 @@
"section": "def-common.Query",
"text": "Query"
},
" | undefined; version?: string | undefined; filters?: ",
" | undefined; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
@ -2195,7 +2256,7 @@
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; description?: string | undefined; refreshInterval?: ",
"[] | undefined; description?: string | undefined; version?: string | undefined; refreshInterval?: ",
{
"pluginId": "data",
"scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.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 |
|-------------------|-----------|------------------------|-----------------|
| 108 | 0 | 105 | 12 |
| 112 | 0 | 109 | 12 |
## Client
@ -37,6 +37,9 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
### Interfaces
<DocDefinitionList data={dashboardObj.client.interfaces}/>
### Enums
<DocDefinitionList data={dashboardObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.client.misc}/>

View file

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

View file

@ -10164,19 +10164,7 @@
},
"; history: ",
"SearchRequest",
"[]; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; setField: <K extends keyof ",
"[]; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -10342,7 +10330,19 @@
"SearchResponse",
"<T, Record<string, ",
"AggregationsAggregate",
">>>>; onRequestStart: (handler: (searchSource: ",
">>>>; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
@ -13208,14 +13208,14 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "visTypeTimeseries",
"path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts"
},
{
"plugin": "visTypeTimeseries",
"path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/state_management/datasource.test.ts"
@ -16349,39 +16349,7 @@
"label": "elasticsearchClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -16487,7 +16455,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -19872,14 +19872,14 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "visTypeTimeseries",
"path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts"
},
{
"plugin": "visTypeTimeseries",
"path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/state_management/datasource.test.ts"

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

View file

@ -2873,11 +2873,11 @@
"label": "options",
"description": [],
"signature": [
"{ search?: string | undefined; page?: number | undefined; filter?: any; aggs?: Record<string, ",
"{ page?: number | undefined; filter?: any; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; namespaces?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
"> | undefined; search?: string | undefined; namespaces?: string[] | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: ",
"SortOrder",
" | undefined; fields?: string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; hasReference?: ",
" | undefined; hasReference?: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
@ -2893,7 +2893,7 @@
"section": "def-common.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
"[] | undefined; preference?: string | undefined; pit?: ",
"[] | undefined; fields?: string[] | undefined; preference?: string | undefined; pit?: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
@ -6996,19 +6996,7 @@
},
"; history: ",
"SearchRequest",
"[]; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; setField: <K extends keyof ",
"[]; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -7174,7 +7162,19 @@
"SearchResponse",
"<T, Record<string, ",
"AggregationsAggregate",
">>>>; onRequestStart: (handler: (searchSource: ",
">>>>; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
@ -16630,7 +16630,7 @@
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any>>(search: () => Promise<Response>, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ",
"<any>>(search: () => Promise<Response>, cancel?: (() => Promise<void>) | undefined, { pollInterval, abortSignal }?: ",
{
"pluginId": "data",
"scope": "common",
@ -16669,7 +16669,7 @@
"label": "cancel",
"description": [],
"signature": [
"(() => void) | undefined"
"(() => Promise<void>) | undefined"
],
"path": "src/plugins/data/common/search/poll_search.ts",
"deprecated": false,
@ -25592,7 +25592,7 @@
"label": "aggregate",
"description": [],
"signature": [
"\"concat\" | \"min\" | \"max\" | \"sum\" | \"average\""
"\"min\" | \"max\" | \"sum\" | \"concat\" | \"average\""
],
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
"deprecated": false,
@ -34094,19 +34094,7 @@
},
"; history: ",
"SearchRequest",
"[]; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; setField: <K extends keyof ",
"[]; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -34272,7 +34260,19 @@
"SearchResponse",
"<T, Record<string, ",
"AggregationsAggregate",
">>>>; onRequestStart: (handler: (searchSource: ",
">>>>; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

View file

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

View file

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

View file

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

File diff suppressed because one or more lines are too long

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

View file

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

View file

@ -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-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -18,10 +18,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, savedObjectsTagging, ml, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, visualizations, aiops, dataVisualizer, ml, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, savedObjects, embeddable, visualizations, canvas, graph, ml, @kbn/core-saved-objects-common, @kbn/core-saved-objects-server, actions, alerting, savedSearch, enterpriseSearch, securitySolution, taskManager, @kbn/core-saved-objects-server-internal, @kbn/core-saved-objects-api-server | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.migrations" text="migrations"/> | @kbn/core-saved-objects-base-server-internal, @kbn/core-saved-objects-migration-server-internal, @kbn/core-saved-objects-server-internal, @kbn/core-ui-settings-server-internal, @kbn/core-usage-data-server-internal, spaces, taskManager, actions, @kbn/core-saved-objects-migration-server-mocks, share, dataViews, data, alerting, lens, cases, apmDataAccess, visualizations, ml, savedSearch, canvas, fleet, cloudSecurityPosture, logsShared, graph, lists, maps, infra, securitySolution, apm, slo, synthetics, uptime, dashboard, eventAnnotation, links, savedObjectsManagement, @kbn/core-test-helpers-so-type-serializer, @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.migrations" text="migrations"/> | @kbn/core-saved-objects-base-server-internal, @kbn/core-saved-objects-migration-server-internal, @kbn/core-saved-objects-server-internal, @kbn/core-ui-settings-server-internal, @kbn/core-usage-data-server-internal, spaces, taskManager, actions, @kbn/core-saved-objects-migration-server-mocks, share, dataViews, data, alerting, lens, cases, savedSearch, canvas, fleet, cloudSecurityPosture, ml, logsShared, graph, lists, maps, visualizations, infra, apmDataAccess, securitySolution, apm, slo, synthetics, uptime, dashboard, eventAnnotation, links, savedObjectsManagement, @kbn/core-test-helpers-so-type-serializer, @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | graph, stackAlerts, inputControlVis, securitySolution, savedObjects | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dashboard, dataVisualizer, stackAlerts, expressionPartitionVis | - |
@ -29,7 +29,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibAlertingPluginApi" section="def-common.MaintenanceWindow" text="MaintenanceWindow"/> | triggersActionsUi | - |
| <DocLink id="kibManagementPluginApi" section="def-public.ManagementAppMountParams.theme$" text="theme$"/> | triggersActionsUi | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttribute" text="SavedObjectAttribute"/> | @kbn/core, visualizations, triggersActionsUi | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | ruleRegistry, securitySolution, synthetics, uptime, slo | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | ruleRegistry, securitySolution, synthetics, slo | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.SavedObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-server-internal, fleet, graph, lists, osquery, securitySolution, alerting | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-server-internal, fleet, graph, lists, osquery, securitySolution, alerting | - |
@ -43,7 +43,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibTimelinesPluginApi" section="def-common.IndexFieldsStrategyRequest" text="IndexFieldsStrategyRequest"/> | securitySolution | - |
| <DocLink id="kibTimelinesPluginApi" section="def-common.IndexFieldsStrategyResponse" text="IndexFieldsStrategyResponse"/> | securitySolution | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, savedObjectsTagging, canvas, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, visualizations, savedSearch, canvas, savedObjectsTagging, graph, lists, maps, securitySolution, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, savedSearch, canvas, savedObjectsTagging, graph, lists, maps, visualizations, securitySolution, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_ID" text="ENDPOINT_TRUSTED_APPS_LIST_ID"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_NAME" text="ENDPOINT_TRUSTED_APPS_LIST_NAME"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION" text="ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
@ -57,12 +57,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | securitySolution | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | securitySolution | - |
| <DocLink id="kibKbnUiThemePluginApi" section="def-common.darkMode" text="darkMode"/> | @kbn/monaco, securitySolution | - |
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | dataVisualizer, fleet, cloudSecurityPosture, exploratoryView, osquery, synthetics | - |
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | fleet, cloudSecurityPosture, dataVisualizer, exploratoryView, osquery, synthetics | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, imageEmbeddable, embeddable | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, home, savedObjects, unifiedSearch, visualizations, fileUpload, dashboardEnhanced, transform, dashboard, discover, dataVisualizer | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.resolve" text="resolve"/> | @kbn/core-saved-objects-browser-mocks, discover, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | @kbn/management-settings-field-definition, discover | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | discover, @kbn/management-settings-field-definition | - |
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | monitoring | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, data, embeddable, uiActionsEnhanced, controls, canvas, maps, dashboardEnhanced, globalSearchProviders | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - |
@ -95,12 +95,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsBrowserInternalPluginApi" section="def-common.SavedObjectsService" text="SavedObjectsService"/> | @kbn/core-root-browser-internal, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-common.SavedObjectsIncrementCounterOptions.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-common.SavedObjectsBulkCreateObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-migration-server-internal, spaces, data, visualizations, savedSearch, cloudSecurityPosture, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | data, visualizations, dashboard, observabilityShared, maps, timelines, fleet, cloudSecurityPosture, console, runtimeFields, indexManagement, graph, eventAnnotationListing, filesManagement | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | maps, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, fleet, devTools, console, crossClusterReplication, grokdebugger, ingestPipelines, metricsDataAccess, osquery, infra, painlessLab, searchprofiler, apm, observabilityOnboarding, filesManagement | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-migration-server-internal, spaces, data, savedSearch, cloudSecurityPosture, visualizations, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | data, timelines, fleet, observabilityShared, cloudSecurityPosture, console, runtimeFields, indexManagement | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | maps, fleet, devTools, console, crossClusterReplication, grokdebugger, ingestPipelines, osquery, infra, painlessLab, searchprofiler, metricsDataAccess, apm, observabilityOnboarding, filesManagement | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | graph, visTypeTimeseries, dataViewManagement, dataViews | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | graph, visTypeTimeseries, dataViewManagement, dataViews | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | graph, visTypeTimeseries, dataViewManagement | - |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | visualizations, graph | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects | - |
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-common.apiHasLegacyLibraryTransforms" text="apiHasLegacyLibraryTransforms"/> | dashboard | - |
@ -150,7 +150,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnReportingExportTypesPdfCommonPluginApi" section="def-common.JobParamsPDFDeprecated" text="JobParamsPDFDeprecated"/> | @kbn/reporting-export-types-pdf, reporting | - |
| <DocLink id="kibKbnReportingPublicPluginApi" section="def-public.ReportingAPIClient.createImmediateReport" text="createImmediateReport"/> | @kbn/reporting-csv-share-panel | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, aiops, licenseManagement, ml, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher, profiling, apm, slo | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, aiops, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, osquery, securitySolution, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
| <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.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting, cases | 8.8.0 |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -328,7 +328,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKbnUiThemePluginApi" section="def-common.darkMode" text="darkMode"/> | [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [shared.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme/shared.ts#:~:text=darkMode), [shared.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme/shared.ts#:~:text=darkMode) | - |
| <DocLink id="kibKbnUiThemePluginApi" section="def-common.darkMode" text="darkMode"/> | [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [esql_theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/esql/lib/esql_theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode), [theme.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-monaco/src/console/theme.ts#:~:text=darkMode) | - |
@ -536,7 +536,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/types.ts#:~:text=fieldFormats), [data_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/data_service.ts#:~:text=fieldFormats) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_listing/dashboard_listing.tsx#:~:text=toMountPoint), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_listing/dashboard_listing.tsx#:~:text=toMountPoint), [dashboard_listing_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_listing/dashboard_listing_table.tsx#:~:text=toMountPoint), [dashboard_listing_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_listing/dashboard_listing_table.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [add_to_library_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/add_to_library_action.tsx#:~:text=SavedObjectSaveModal), [add_to_library_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/add_to_library_action.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | [duplicate_dashboard_panel.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/duplicate_dashboard_panel.test.ts#:~:text=savedObjects), [duplicate_dashboard_panel.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/duplicate_dashboard_panel.test.ts#:~:text=savedObjects) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.create" text="create"/> | [duplicate_dashboard_panel.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/duplicate_dashboard_panel.test.ts#:~:text=create) | - |
@ -693,14 +692,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## eventAnnotationListing
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [get_table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation_listing/public/get_table_list.tsx#:~:text=toMountPoint), [get_table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation_listing/public/get_table_list.tsx#:~:text=toMountPoint) | - |
## exploratoryView
| Deprecated API | Reference location(s) | Remove By |
@ -710,30 +701,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## expressionError
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [error_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/error_renderer.tsx#:~:text=KibanaThemeProvider), [error_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/error_renderer.tsx#:~:text=KibanaThemeProvider), [error_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/error_renderer.tsx#:~:text=KibanaThemeProvider), [debug_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx#:~:text=KibanaThemeProvider), [debug_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx#:~:text=KibanaThemeProvider), [debug_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressionImage
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_image/public/expression_renderers/image_renderer.tsx#:~:text=KibanaThemeProvider), [image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_image/public/expression_renderers/image_renderer.tsx#:~:text=KibanaThemeProvider), [image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_image/public/expression_renderers/image_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressionMetric
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [metric_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx#:~:text=KibanaThemeProvider), [metric_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx#:~:text=KibanaThemeProvider), [metric_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressionPartitionVis
| Deprecated API | Reference location(s) | Remove By |
@ -742,30 +709,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## expressionRepeatImage
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [repeat_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx#:~:text=KibanaThemeProvider), [repeat_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx#:~:text=KibanaThemeProvider), [repeat_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressionRevealImage
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [reveal_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx#:~:text=KibanaThemeProvider), [reveal_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx#:~:text=KibanaThemeProvider), [reveal_image_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressionShape
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [shape_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx#:~:text=KibanaThemeProvider), [shape_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx#:~:text=KibanaThemeProvider), [shape_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx#:~:text=KibanaThemeProvider), [progress_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx#:~:text=KibanaThemeProvider), [progress_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx#:~:text=KibanaThemeProvider), [progress_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx#:~:text=KibanaThemeProvider) | - |
## expressions
| Deprecated API | Reference location(s) | Remove By |
@ -786,7 +729,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=toMountPoint), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-public.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/app.tsx#:~:text=withoutPageTemplateWrapper) | - |
@ -826,7 +768,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=toMountPoint), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/application.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | [source_picker.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/source_picker.tsx#:~:text=includeFields) | - |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
@ -1016,7 +957,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-server.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.registerSavedObjectToPanelMethod" text="registerSavedObjectToPanelMethod"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/plugin.ts#:~:text=registerSavedObjectToPanelMethod), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/plugin.ts#:~:text=registerSavedObjectToPanelMethod) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=toMountPoint), [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [map_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx#:~:text=KibanaThemeProvider), [map_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx#:~:text=KibanaThemeProvider), [map_embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx#:~:text=KibanaThemeProvider), [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=KibanaThemeProvider), [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=KibanaThemeProvider), [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=ResolvedSimpleSavedObject), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=ResolvedSimpleSavedObject), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=ResolvedSimpleSavedObject), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=ResolvedSimpleSavedObject) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=SavedObjectReference), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=SavedObjectReference) | - |
@ -1038,7 +978,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider), [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider), [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider), [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider), [common_providers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/metrics_data_access/public/apps/common_providers.tsx#:~:text=KibanaThemeProvider) | - |
@ -1438,7 +1378,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/common.ts#:~:text=alertFactory), [status_check.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/status_check.ts#:~:text=alertFactory), [tls.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/tls.ts#:~:text=alertFactory), [duration_anomaly.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/alerts/duration_anomaly.ts#:~:text=alertFactory) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.migrations" text="migrations"/> | [uptime_settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/saved_objects/uptime_settings.ts#:~:text=migrations) | - |
@ -1476,7 +1415,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibEmbeddablePluginApi" section="def-public.registerSavedObjectToPanelMethod" text="registerSavedObjectToPanelMethod"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=registerSavedObjectToPanelMethod), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=registerSavedObjectToPanelMethod) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=toMountPoint), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=toMountPoint) | - |
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | [search_selection.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx#:~:text=includeFields), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=includeFields) | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=savedObjects), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=savedObjects) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=SavedObjectsClientContract), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/plugin.ts#:~:text=SavedObjectsClientContract) | - |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

View file

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

View file

@ -102,7 +102,13 @@
"label": "result",
"description": [],
"signature": [
"DataTableRecord",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts",
@ -525,6 +531,74 @@
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverCustomizationService.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"<TCustomizationId extends \"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\" | \"data_table\" | \"field_list\">(id: TCustomizationId) => Extract<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.FlyoutCustomization",
"text": "FlyoutCustomization"
},
", { id: TCustomizationId; }> | Extract<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SearchBarCustomization",
"text": "SearchBarCustomization"
},
", { id: TCustomizationId; }> | Extract<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.TopNavCustomization",
"text": "TopNavCustomization"
},
", { id: TCustomizationId; }> | Extract<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.UnifiedHistogramCustomization",
"text": "UnifiedHistogramCustomization"
},
", { id: TCustomizationId; }> | Extract<",
"DataTableCustomization",
", { id: TCustomizationId; }> | Extract<",
"FieldListCustomization",
", { id: TCustomizationId; }> | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverCustomizationService.get.$1",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"TCustomizationId"
],
"path": "src/plugins/discover/public/customizations/customization_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverCustomizationService.get$",
@ -970,7 +1044,13 @@
"label": "doc",
"description": [],
"signature": [
"DataTableRecord"
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
@ -2534,14 +2614,6 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx"
},
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx"
@ -2550,6 +2622,14 @@
"plugin": "cloudSecurityPosture",
"path": "x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx"
},
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx"
},
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx"
},
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/hooks/use_discover_link.tsx"

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 146 | 0 | 99 | 27 |
| 148 | 0 | 101 | 27 |
## Client

View file

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

View file

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

View file

@ -133,7 +133,9 @@
},
") => ",
"Tool",
" | null"
" | ",
"DynamicStructuredTool",
"<Zod.ZodObject<any, any, any, any, { [x: string]: any; }>> | null"
],
"path": "x-pack/plugins/elastic_assistant/server/types.ts",
"deprecated": false,
@ -239,39 +241,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -377,7 +347,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -1643,7 +1645,7 @@
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string, state?: ",
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string, state?: ",
"AnomalyDetectionRuleState",
" | undefined) => Promise<{ payload: ",
"AnomalyDetectionAlertPayload",

View file

@ -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-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

View file

@ -708,7 +708,7 @@
"section": "def-common.PanelPackage",
"text": "PanelPackage"
},
") => Promise<ApiType | undefined>"
"<object>) => Promise<ApiType | undefined>"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
@ -728,7 +728,8 @@
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-common.PanelPackage",
"text": "PanelPackage"
}
},
"<object>"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
@ -754,7 +755,7 @@
"section": "def-common.PanelPackage",
"text": "PanelPackage"
},
") => Promise<string>"
"<object>) => Promise<string>"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
@ -789,7 +790,8 @@
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-common.PanelPackage",
"text": "PanelPackage"
}
},
"<object>"
],
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false,
@ -2227,7 +2229,7 @@
"label": "onEdit",
"description": [],
"signature": [
"() => void"
"() => Promise<void>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false,
@ -6096,7 +6098,7 @@
"label": "getEditHref",
"description": [],
"signature": [
"() => string | undefined"
"() => Promise<string | undefined>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false,
@ -6114,10 +6116,10 @@
"signature": [
"() => ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableAppContext",
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableAppContext",
"text": "EmbeddableAppContext"
},
" | undefined"
@ -9234,7 +9236,7 @@
"section": "def-public.ReactEmbeddableFactory",
"text": "ReactEmbeddableFactory"
},
"<StateType, APIType>>) => void"
"<StateType, APIType, StateType>>) => void"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_registry.ts",
"deprecated": false,
@ -9275,7 +9277,7 @@
"section": "def-public.ReactEmbeddableFactory",
"text": "ReactEmbeddableFactory"
},
"<StateType, APIType>>"
"<StateType, APIType, StateType>>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_registry.ts",
"deprecated": false,
@ -9874,7 +9876,7 @@
"label": "startTrackingEmbeddableUnsavedChanges",
"description": [],
"signature": [
"<StateType extends object = object>(uuid: string, parentApi: unknown, comparators: ",
"<SerializedState extends object = object, RuntimeState extends object = object>(uuid: string, parentApi: unknown, comparators: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
@ -9882,7 +9884,7 @@
"section": "def-common.StateComparators",
"text": "StateComparators"
},
"<StateType>, deserializeState: (state: ",
"<RuntimeState>, deserializeState: (state: ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "common",
@ -9890,11 +9892,11 @@
"section": "def-common.SerializedPanelState",
"text": "SerializedPanelState"
},
"<object>) => StateType) => { unsavedChanges: ",
"<SerializedState>) => RuntimeState) => { unsavedChanges: ",
"BehaviorSubject",
"<object | undefined>; resetUnsavedChanges: () => void; cleanup: () => void; } | { unsavedChanges: ",
"BehaviorSubject",
"<Partial<StateType> | undefined>; resetUnsavedChanges: () => void; cleanup: () => void; }"
"<Partial<RuntimeState> | undefined>; resetUnsavedChanges: () => void; cleanup: () => void; }"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_unsaved_changes.ts",
"deprecated": false,
@ -9945,7 +9947,7 @@
"section": "def-common.StateComparators",
"text": "StateComparators"
},
"<StateType>"
"<RuntimeState>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_unsaved_changes.ts",
"deprecated": false,
@ -9968,7 +9970,7 @@
"section": "def-common.SerializedPanelState",
"text": "SerializedPanelState"
},
"<object>) => StateType"
"<SerializedState>) => RuntimeState"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_unsaved_changes.ts",
"deprecated": false,
@ -10291,7 +10293,7 @@
"section": "def-public.DefaultEmbeddableApi",
"text": "DefaultEmbeddableApi"
},
"<StateType> extends ",
"<SerializedState> extends ",
"DefaultPresentationPanelApi",
",",
{
@ -10317,7 +10319,7 @@
"section": "def-common.HasSerializableState",
"text": "HasSerializableState"
},
"<StateType>"
"<SerializedState>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -10325,52 +10327,6 @@
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableAppContext",
"type": "Interface",
"tags": [],
"label": "EmbeddableAppContext",
"description": [],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableAppContext.getCurrentPath",
"type": "Function",
"tags": [],
"label": "getCurrentPath",
"description": [
"\nCurrent app's path including query and hash starting from {appId}"
],
"signature": [
"(() => string) | undefined"
],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableAppContext.currentAppId",
"type": "string",
"tags": [],
"label": "currentAppId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableContainerSettings",
@ -10526,19 +10482,12 @@
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableEditorState.valueInput",
"type": "Object",
"type": "Unknown",
"tags": [],
"label": "valueInput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
" | undefined"
"unknown"
],
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
"deprecated": false,
@ -11419,31 +11368,12 @@
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddablePackageState.input",
"type": "CompoundType",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"Optional",
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", \"id\"> | ",
"Optional",
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
", \"id\">"
"unknown"
],
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
"deprecated": false,
@ -13035,10 +12965,10 @@
"signature": [
"() => ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableAppContext",
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableAppContext",
"text": "EmbeddableAppContext"
},
" | undefined"
@ -13465,7 +13395,9 @@
"type": "Interface",
"tags": [],
"label": "ReactEmbeddableFactory",
"description": [],
"description": [
"\nThe React Embeddable Factory interface is used to register a series of functions that\ncreate and manage an embeddable instance.\n\nEmbeddables are React components that manage their own state, can be serialized and\ndeserialized, and return an API that can be used to interact with them imperatively.\nprovided by the parent, and will not save any state to an external store."
],
"signature": [
{
"pluginId": "embeddable",
@ -13474,7 +13406,7 @@
"section": "def-public.ReactEmbeddableFactory",
"text": "ReactEmbeddableFactory"
},
"<StateType, ApiType>"
"<SerializedState, ApiType, RuntimeState>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13486,20 +13418,8 @@
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ReactEmbeddableFactory.latestVersion",
"type": "string",
"tags": [],
"label": "latestVersion",
"description": [],
"signature": [
"string | undefined"
"description": [
"\nA unique key for the type of this embeddable. The React Embeddable Renderer will use this type\nto find this factory."
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13511,7 +13431,9 @@
"type": "Function",
"tags": [],
"label": "deserializeState",
"description": [],
"description": [
"\nA required synchronous function that transforms serialized state into runtime state.\nThis will be used twice - once for the parent state, and once for the last saved state\nfor comparison.\n\nThis can also be used to:\n\n- Inject references provided by the parent\n- Migrate the state to a newer version (this must be undone when serializing)"
],
"signature": [
"(state: ",
{
@ -13521,7 +13443,7 @@
"section": "def-common.SerializedPanelState",
"text": "SerializedPanelState"
},
"<object>) => StateType"
"<SerializedState>) => RuntimeState"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13542,7 +13464,7 @@
"section": "def-common.SerializedPanelState",
"text": "SerializedPanelState"
},
"<object>"
"<SerializedState>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13558,11 +13480,13 @@
"type": "Function",
"tags": [],
"label": "buildEmbeddable",
"description": [],
"description": [
"\nA required async function that builds your embeddable component and a linked API instance. The API\nand component will be combined together by the ReactEmbeddableRenderer. Initial state will contain the result of\nthe deserialize function.\n\nThe returned API must extend {@link HasSerializableState} which does the opposite of the deserializeState\nfunction."
],
"signature": [
"(initialState: StateType, buildApi: (apiRegistration: ",
"(initialState: RuntimeState, buildApi: (apiRegistration: ",
"ReactEmbeddableApiRegistration",
"<StateType, ApiType>, comparators: ",
"<SerializedState, ApiType>, comparators: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
@ -13570,7 +13494,7 @@
"section": "def-common.StateComparators",
"text": "StateComparators"
},
"<StateType>) => ApiType, uuid: string, parentApi?: unknown) => Promise<{ Component: React.FC<{}>; api: ApiType; }>"
"<RuntimeState>) => ApiType, uuid: string, parentApi?: unknown) => Promise<{ Component: React.FC<{}>; api: ApiType; }>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13584,7 +13508,7 @@
"label": "initialState",
"description": [],
"signature": [
"StateType"
"RuntimeState"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -13601,7 +13525,7 @@
"signature": [
"(apiRegistration: ",
"ReactEmbeddableApiRegistration",
"<StateType, ApiType>, comparators: ",
"<SerializedState, ApiType>, comparators: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
@ -13609,7 +13533,7 @@
"section": "def-common.StateComparators",
"text": "StateComparators"
},
"<StateType>) => ApiType"
"<RuntimeState>) => ApiType"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 577 | 1 | 470 | 8 |
| 573 | 1 | 463 | 8 |
## Client

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

View file

@ -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-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

View file

@ -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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: 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; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | 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<{ active?: string | number | undefined; new?: string | number | undefined; recovered?: 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; version?: 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; space_ids?: string[] | 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; timezone?: string | undefined; duration?: string | number | undefined; category?: string[] | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; category?: string | undefined; description?: string | undefined; version?: 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; 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; version?: 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; space_ids?: string[] | 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; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: 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; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | 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<{ active?: string | number | undefined; new?: string | number | undefined; recovered?: 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; version?: 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; space_ids?: string[] | 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; timezone?: string | undefined; duration?: string | number | undefined; category?: string[] | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; category?: string | undefined; description?: string | undefined; version?: 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; 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; version?: 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; space_ids?: string[] | 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; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: 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; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | 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<{ active?: string | number | undefined; new?: string | number | undefined; recovered?: 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; version?: 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; space_ids?: string[] | 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; timezone?: string | undefined; duration?: string | number | undefined; category?: string[] | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; category?: string | undefined; description?: string | undefined; version?: 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; 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; version?: 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; space_ids?: string[] | 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; category?: string[] | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: 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,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

View file

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

View file

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

View file

@ -905,9 +905,9 @@
"label": "AllowedGaugeOverrides",
"description": [],
"signature": [
"{ gauge?: { id: string; subtype: ",
"{ gauge?: { id: string; target?: number | undefined; subtype: ",
"GoalSubtype",
"; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
"; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
@ -1191,9 +1191,9 @@
"section": "def-public.PersistedState",
"text": "PersistedState"
},
"; overrides?: (Partial<Record<\"gauge\", { id: string; subtype: ",
"; overrides?: (Partial<Record<\"gauge\", { id: string; target?: number | undefined; subtype: ",
"GoalSubtype",
"; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
"; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -711,8 +711,8 @@
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.LegendStats",
"text": "LegendStats"
"section": "def-common.PartitionLegendValue",
"text": "PartitionLegendValue"
},
"[] | undefined"
],
@ -1013,8 +1013,8 @@
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.LegendStats",
"text": "LegendStats"
"section": "def-common.PartitionLegendValue",
"text": "PartitionLegendValue"
},
"[] | undefined"
],

View file

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

View file

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

View file

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

View file

@ -635,7 +635,7 @@
"label": "strokeLinecap",
"description": [],
"signature": [
"\"square\" | \"inherit\" | \"butt\" | \"round\" | undefined"
"\"inherit\" | \"butt\" | \"round\" | \"square\" | undefined"
],
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"deprecated": false,

View file

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

View file

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

View file

@ -417,7 +417,7 @@
"label": "mode",
"description": [],
"signature": [
"\"custom\" | \"full\" | \"dataBounds\""
"\"full\" | \"custom\" | \"dataBounds\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -1059,8 +1059,8 @@
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.LegendStats",
"text": "LegendStats"
"section": "def-common.XYLegendValue",
"text": "XYLegendValue"
},
"[] | undefined"
],
@ -2310,7 +2310,7 @@
"label": "AxisExtentMode",
"description": [],
"signature": [
"\"custom\" | \"full\" | \"dataBounds\""
"\"full\" | \"custom\" | \"dataBounds\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2325,7 +2325,7 @@
"label": "AxisMode",
"description": [],
"signature": [
"\"normal\" | \"percentage\" | \"wiggle\" | \"silhouette\""
"\"percentage\" | \"normal\" | \"wiggle\" | \"silhouette\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -3573,7 +3573,7 @@
"label": "YScaleType",
"description": [],
"signature": [
"\"log\" | \"sqrt\" | \"time\" | \"linear\""
"\"log\" | \"time\" | \"linear\" | \"sqrt\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -843,39 +843,7 @@
"\nAn elasticsearch client that will be used to interact with the cluster."
],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -981,7 +949,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",

View file

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

View file

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

View file

@ -1554,6 +1554,20 @@
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.NewPackagePolicy.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"{ inputs?: { [key: string]: any; } | undefined; } | null | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -2788,7 +2802,7 @@
"section": "def-common.PackagePolicyConfigRecord",
"text": "PackagePolicyConfigRecord"
},
" | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; }"
" | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; overrides?: { inputs?: { [key: string]: any; } | undefined; } | null | undefined; }"
],
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
"deprecated": false,
@ -5737,7 +5751,7 @@
"\nReturn the status by the Agent's id"
],
"signature": [
"(agentId: string) => Promise<\"error\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\" | \"degraded\">"
"(agentId: string) => Promise<\"error\" | \"offline\" | \"online\" | \"inactive\" | \"degraded\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\">"
],
"path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts",
"deprecated": false,
@ -11583,39 +11597,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -11721,7 +11703,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -12954,39 +12968,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -13092,7 +13074,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -14338,39 +14352,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -14476,7 +14458,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -15719,39 +15733,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -15857,7 +15839,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -17103,39 +17117,7 @@
"label": "esClient",
"description": [],
"signature": [
"{ search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -17241,7 +17223,39 @@
"WriteResponseBase",
">; }; helpers: ",
"default",
"; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kQueryRuleset]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; child: (opts: ",
"ClientOptions",
@ -19022,7 +19036,7 @@
"label": "status",
"description": [],
"signature": [
"\"error\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\" | \"degraded\" | undefined"
"\"error\" | \"offline\" | \"online\" | \"inactive\" | \"degraded\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\" | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"deprecated": false,
@ -20553,7 +20567,7 @@
"\nLast checkin status"
],
"signature": [
"\"error\" | \"online\" | \"updating\" | \"degraded\" | undefined"
"\"error\" | \"online\" | \"degraded\" | \"updating\" | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"deprecated": false,
@ -21327,7 +21341,7 @@
"label": "statusSummary",
"description": [],
"signature": [
"Record<\"error\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\" | \"degraded\", number> | undefined"
"Record<\"error\" | \"offline\" | \"online\" | \"inactive\" | \"degraded\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\", number> | undefined"
],
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"deprecated": false,
@ -21383,6 +21397,7 @@
"label": "items",
"description": [],
"signature": [
"(",
{
"pluginId": "fleet",
"scope": "common",
@ -21390,7 +21405,7 @@
"section": "def-common.SimpleSOAssetType",
"text": "SimpleSOAssetType"
},
"[]"
" & { appLink?: string | undefined; })[]"
],
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"deprecated": false,
@ -22878,6 +22893,20 @@
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.NewPackagePolicy.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"{ inputs?: { [key: string]: any; } | undefined; } | null | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -25071,7 +25100,7 @@
"label": "attributes",
"description": [],
"signature": [
"{ title?: string | undefined; description?: string | undefined; }"
"{ service?: string | undefined; title?: string | undefined; description?: string | undefined; }"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
@ -25481,60 +25510,13 @@
"label": "AgentStatus",
"description": [],
"signature": [
"\"error\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\" | \"degraded\""
"\"error\" | \"offline\" | \"online\" | \"inactive\" | \"degraded\" | \"enrolling\" | \"unenrolling\" | \"unenrolled\" | \"updating\""
],
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AllowedAssetTypes",
"type": "Type",
"tags": [],
"label": "AllowedAssetTypes",
"description": [],
"signature": [
"[",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".dashboard, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".search, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".visualization, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ElasticsearchAssetType",
"text": "ElasticsearchAssetType"
},
".transform]"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.ArchivePackage",
@ -25688,6 +25670,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.DisplayedAssetTypes",
"type": "Type",
"tags": [],
"label": "DisplayedAssetTypes",
"description": [],
"signature": [
"(\"search\" | \"map\" | \"index\" | \"transform\" | \"tag\" | \"dashboard\" | \"index-pattern\" | \"lens\" | \"visualization\" | \"ml-module\" | \"security-rule\" | \"csp-rule-template\" | \"osquery-pack-asset\" | \"osquery-saved-query\" | \"index_template\" | \"component_template\" | \"ingest_pipeline\" | \"ilm_policy\" | \"data_stream_ilm_policy\" | \"ml_model\")[]"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.DocAssetType",
@ -25763,7 +25760,15 @@
"label": "ElasticsearchAssetTypeToParts",
"description": [],
"signature": [
"{ component_template: ",
"{ index_template: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; component_template: ",
{
"pluginId": "fleet",
"scope": "common",
@ -25779,14 +25784,6 @@
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; index_template: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; ilm_policy: ",
{
"pluginId": "fleet",
@ -25795,7 +25792,7 @@
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; transform: ",
"[]; data_stream_ilm_policy: ",
{
"pluginId": "fleet",
"scope": "common",
@ -25803,7 +25800,7 @@
"section": "def-common.ElasticsearchAssetParts",
"text": "ElasticsearchAssetParts"
},
"[]; data_stream_ilm_policy: ",
"[]; transform: ",
{
"pluginId": "fleet",
"scope": "common",
@ -26400,6 +26397,14 @@
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; lens: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; visualization: ",
{
"pluginId": "fleet",
@ -26432,7 +26437,7 @@
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; lens: ",
"[]; ml_module: ",
{
"pluginId": "fleet",
"scope": "common",
@ -26456,22 +26461,6 @@
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; ml_module: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; tag: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; osquery_pack_asset: ",
{
"pluginId": "fleet",
@ -26488,6 +26477,14 @@
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; tag: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetParts",
"text": "KibanaAssetParts"
},
"[]; }"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
@ -26896,7 +26893,7 @@
"label": "RegistrySearchResult",
"description": [],
"signature": [
"{ type?: \"input\" | \"integration\" | undefined; name: string; title: string; version: string; description: string; path: string; download: string; internal?: boolean | undefined; icons?: (",
"{ type?: \"input\" | \"integration\" | undefined; name: string; title: string; description: string; version: string; path: string; download: string; internal?: boolean | undefined; icons?: (",
{
"pluginId": "fleet",
"scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2024-04-29
date: 2024-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1298 | 5 | 1177 | 66 |
| 1300 | 5 | 1179 | 66 |
## Client

View file

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

View file

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

View file

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

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