[api-docs] 2024-11-06 Daily api_docs build (#199078)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/883
This commit is contained in:
Kibana Machine 2024-11-06 18:30:21 +11:00 committed by GitHub
parent 665cf98067
commit 0120b2a4f1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
803 changed files with 2261 additions and 1280 deletions

View file

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

View file

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

View file

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

View file

@ -533,33 +533,14 @@
"\nUsed to create deep links to other plugins." "\nUsed to create deep links to other plugins."
], ],
"signature": [ "signature": [
"{ toggleShareContextMenu: (options: ",
{ {
"pluginId": "share", "pluginId": "share",
"scope": "public", "scope": "public",
"docId": "kibSharePluginApi", "docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions", "section": "def-public.SharePublicStart",
"text": "ShowShareMenuOptions" "text": "SharePublicStart"
}, },
") => void; } & { url: ", " | undefined"
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.BrowserUrlService",
"text": "BrowserUrlService"
},
"; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">): void; }"
], ],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts", "path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false, "deprecated": false,
@ -642,33 +623,33 @@
"\nDeps for unified fields stats." "\nDeps for unified fields stats."
], ],
"signature": [ "signature": [
"{ useFieldStatsTrigger: () => { renderOption: ((option: ", "{ useFieldStatsTrigger: <T = ",
"EuiComboBoxOptionOption",
"<string>, searchValue: string, OPTION_CONTENT_CLASSNAME: string) => React.ReactNode) | undefined; closeFlyout: () => void; }; FieldStatsFlyoutProvider: React.FC<React.PropsWithChildren<{ dataView: ",
{ {
"pluginId": "dataViews", "pluginId": "@kbn/ml-field-stats-flyout",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"; fieldStatsServices: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "public", "scope": "public",
"docId": "kibKbnUnifiedFieldListPluginApi", "docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.FieldStatsServices", "section": "def-public.DropDownLabel",
"text": "FieldStatsServices" "text": "DropDownLabel"
}, },
"; timeRangeMs?: ", "<string>>() => { renderOption: (option: T) => React.ReactNode; setIsFlyoutVisible: (v: boolean) => void; setFieldName: (v: string | undefined) => void; handleFieldStatsButtonClick: (field: ",
{ {
"pluginId": "@kbn/ml-date-picker", "pluginId": "@kbn/ml-field-stats-flyout",
"scope": "public", "scope": "public",
"docId": "kibKbnMlDatePickerPluginApi", "docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.TimeRange", "section": "def-public.FieldForStats",
"text": "TimeRange" "text": "FieldForStats"
}, },
" | undefined; dslQuery?: object | undefined; }>>; } | undefined" ") => void; closeFlyout: () => void; optionCss: ",
"SerializedStyles",
"; populatedFields: Set<string> | undefined; }; FieldStatsFlyoutProvider: React.FC<",
{
"pluginId": "@kbn/ml-field-stats-flyout",
"scope": "public",
"docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.FieldStatsFlyoutProviderProps",
"text": "FieldStatsFlyoutProviderProps"
},
">; } | undefined"
], ],
"path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts", "path": "x-pack/plugins/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false, "deprecated": false,

View file

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

View file

@ -3358,7 +3358,7 @@
"label": "lastRun", "label": "lastRun",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"ruleExecution\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined" "Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"disabled\" | \"ruleExecution\" | \"timeout\" | \"read\" | \"decrypt\" | \"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", "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
"deprecated": false, "deprecated": false,
@ -4672,7 +4672,7 @@
"label": "BulkEditOperation", "label": "BulkEditOperation",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{} & { value: string[]; operation: \"delete\" | \"add\" | \"set\"; field: \"tags\"; }> | Readonly<{} & { value: (Readonly<{ actionTypeId?: string | undefined; frequency?: Readonly<{} & { throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; summary: boolean; }> | undefined; alertsFilter?: Readonly<{ query?: Readonly<{ dsl?: string | undefined; } & { kql: string; filters: Readonly<{ query?: Record<string, any> | undefined; $state?: Readonly<{} & { store: ", "Readonly<{} & { value: string[]; field: \"tags\"; operation: \"delete\" | \"add\" | \"set\"; }> | Readonly<{} & { value: (Readonly<{ actionTypeId?: string | undefined; frequency?: Readonly<{} & { throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; summary: boolean; }> | undefined; alertsFilter?: Readonly<{ query?: Readonly<{ dsl?: string | undefined; } & { kql: string; filters: Readonly<{ query?: Record<string, any> | undefined; $state?: Readonly<{} & { store: ",
{ {
"pluginId": "@kbn/es-query", "pluginId": "@kbn/es-query",
"scope": "common", "scope": "common",
@ -4680,7 +4680,7 @@
"section": "def-common.FilterStateStore", "section": "def-common.FilterStateStore",
"text": "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; 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\"; }>" "; }> | 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; }>)[]; field: \"actions\"; operation: \"add\" | \"set\"; }> | Readonly<{} & { value: Readonly<{} & { interval: string; }>; field: \"schedule\"; operation: \"set\"; }> | Readonly<{} & { value: string | null; field: \"throttle\"; operation: \"set\"; }> | Readonly<{} & { value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; field: \"notifyWhen\"; operation: \"set\"; }> | 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; }>; }>; field: \"snoozeSchedule\"; operation: \"set\"; }> | Readonly<{ value?: string[] | undefined; } & { field: \"snoozeSchedule\"; operation: \"delete\"; }> | Readonly<{} & { field: \"apiKey\"; operation: \"set\"; }>"
], ],
"path": "x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/types/bulk_edit_rules_options.ts", "path": "x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/types/bulk_edit_rules_options.ts",
"deprecated": false, "deprecated": false,
@ -5132,7 +5132,7 @@
"UnsnoozeParams", "UnsnoozeParams",
") => 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<", ") => 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", "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\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }> | Readonly<{} & { error: Readonly<{ status?: number | undefined; } & { message: string; rule: Readonly<{ name?: string | undefined; } & { id: 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: () => ", ">>; 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<{ status?: number | undefined; } & { message: string; rule: Readonly<{ name?: string | undefined; } & { id: 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; 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\"; }>[]; perPage: number; total: number; }>>; deleteBackfill: (id: string) => Promise<{}>; getSpaceId: () => string | undefined; getAuthorization: () => ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "server", "scope": "server",
@ -5148,7 +5148,7 @@
"section": "def-server.AuditLogger", "section": "def-server.AuditLogger",
"text": "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; }>>; }" " | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<Readonly<{} & { page: number; data: string[]; perPage: number; total: number; }>>; getScheduleFrequency: () => Promise<Readonly<{} & { totalScheduledPerMinute: number; remainingSchedulesPerMinute: number; }>>; }"
], ],
"path": "x-pack/plugins/alerting/server/index.ts", "path": "x-pack/plugins/alerting/server/index.ts",
"deprecated": false, "deprecated": false,

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement" title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin description: API docs for the dataViewManagement plugin
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
--- ---
import dataViewManagementObj from './data_view_management.devdocs.json'; 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" title: "dataViews"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin description: API docs for the dataViews plugin
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
--- ---
import dataViewsObj from './data_views.devdocs.json'; import dataViewsObj from './data_views.devdocs.json';

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
title: "datasetQuality" title: "datasetQuality"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the datasetQuality plugin description: API docs for the datasetQuality plugin
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
--- ---
import datasetQualityObj from './dataset_quality.devdocs.json'; 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 slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage 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. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage 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. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1664,7 +1664,7 @@
"section": "def-server.KibanaRequest", "section": "def-server.KibanaRequest",
"text": "KibanaRequest" "text": "KibanaRequest"
}, },
"<unknown, unknown, { actionTypeId: string; subAction: \"invokeAI\" | \"invokeStream\"; replacements: {} & { [k: string]: string; }; message?: string | undefined; allow?: string[] | undefined; size?: number | undefined; conversationId?: string | undefined; model?: string | undefined; alertsIndexPattern?: string | undefined; allowReplacement?: string[] | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; } | { size: number; subAction: \"invokeAI\" | \"invokeStream\"; alertsIndexPattern: string; anonymizationFields: { id: string; field: string; namespace?: string | undefined; timestamp?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; allowed?: boolean | undefined; anonymized?: boolean | undefined; }[]; apiConfig: { connectorId: string; actionTypeId: string; provider?: \"Other\" | \"OpenAI\" | \"Azure OpenAI\" | undefined; model?: string | undefined; defaultSystemPromptId?: string | undefined; }; model?: string | undefined; replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; }, any>" "<unknown, unknown, { actionTypeId: string; subAction: \"invokeAI\" | \"invokeStream\"; replacements: {} & { [k: string]: string; }; message?: string | undefined; size?: number | undefined; allow?: string[] | undefined; conversationId?: string | undefined; model?: string | undefined; alertsIndexPattern?: string | undefined; allowReplacement?: string[] | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; } | { size: number; subAction: \"invokeAI\" | \"invokeStream\"; alertsIndexPattern: string; anonymizationFields: { id: string; field: string; namespace?: string | undefined; timestamp?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; allowed?: boolean | undefined; anonymized?: boolean | undefined; }[]; apiConfig: { connectorId: string; actionTypeId: string; provider?: \"Other\" | \"OpenAI\" | \"Azure OpenAI\" | undefined; model?: string | undefined; defaultSystemPromptId?: string | undefined; }; model?: string | undefined; replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; }, any>"
], ],
"path": "x-pack/plugins/elastic_assistant/server/types.ts", "path": "x-pack/plugins/elastic_assistant/server/types.ts",
"deprecated": false, "deprecated": false,

View file

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

View file

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

View file

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

View file

@ -693,6 +693,20 @@
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.enforceRandomId",
"type": "CompoundType",
"tags": [],
"label": "enforceRandomId",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects" title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin description: API docs for the encryptedSavedObjects plugin
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
--- ---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 53 | 0 | 46 | 1 | | 54 | 0 | 47 | 1 |
## Server ## Server

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -9080,7 +9080,7 @@
"label": "getPackage", "label": "getPackage",
"description": [], "description": [],
"signature": [ "signature": [
"(packageName: string, packageVersion: string, options?: { ignoreUnverified?: boolean | undefined; } | undefined) => Promise<{ paths: string[]; packageInfo: ", "(packageName: string, packageVersion: string, options?: { ignoreUnverified?: boolean | undefined; useStreaming?: boolean | undefined; } | undefined) => Promise<{ paths: string[]; packageInfo: ",
{ {
"pluginId": "fleet", "pluginId": "fleet",
"scope": "common", "scope": "common",
@ -9090,6 +9090,8 @@
}, },
"; assetsMap: ", "; assetsMap: ",
"AssetsMap", "AssetsMap",
"; archiveIterator: ",
"ArchiveIterator",
"; verificationResult?: ", "; verificationResult?: ",
"PackageVerificationResult", "PackageVerificationResult",
" | undefined; }>" " | undefined; }>"
@ -9136,7 +9138,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ ignoreUnverified?: boolean | undefined; } | undefined" "{ ignoreUnverified?: boolean | undefined; useStreaming?: boolean | undefined; } | undefined"
], ],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts", "path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false, "deprecated": false,
@ -9906,7 +9908,7 @@
}, },
" | undefined; bumpRevision?: boolean | undefined; force?: true | undefined; authorizationHeader?: ", " | undefined; bumpRevision?: boolean | undefined; force?: true | undefined; authorizationHeader?: ",
"HTTPAuthorizationHeader", "HTTPAuthorizationHeader",
" | null | undefined; } | undefined) => Promise<{ created: ", " | null | undefined; asyncDeploy?: boolean | undefined; } | undefined) => Promise<{ created: ",
{ {
"pluginId": "fleet", "pluginId": "fleet",
"scope": "common", "scope": "common",
@ -10068,6 +10070,20 @@
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyClient.bulkCreate.$4.asyncDeploy",
"type": "CompoundType",
"tags": [],
"label": "asyncDeploy",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false,
"trackAdoption": false
} }
] ]
} }
@ -10114,7 +10130,7 @@
"section": "def-common.AuthenticatedUser", "section": "def-common.AuthenticatedUser",
"text": "AuthenticatedUser" "text": "AuthenticatedUser"
}, },
" | undefined; force?: boolean | undefined; } | undefined, currentVersion?: string | undefined) => Promise<{ updatedPolicies: ", " | undefined; force?: boolean | undefined; asyncDeploy?: boolean | undefined; } | undefined, currentVersion?: string | undefined) => Promise<{ updatedPolicies: ",
{ {
"pluginId": "fleet", "pluginId": "fleet",
"scope": "common", "scope": "common",
@ -10247,6 +10263,20 @@
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyClient.bulkUpdate.$4.asyncDeploy",
"type": "CompoundType",
"tags": [],
"label": "asyncDeploy",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false,
"trackAdoption": false
} }
] ]
}, },
@ -10921,7 +10951,7 @@
"section": "def-common.AuthenticatedUser", "section": "def-common.AuthenticatedUser",
"text": "AuthenticatedUser" "text": "AuthenticatedUser"
}, },
" | undefined; skipUnassignFromAgentPolicies?: boolean | undefined; force?: boolean | undefined; } | undefined, context?: ", " | undefined; skipUnassignFromAgentPolicies?: boolean | undefined; force?: boolean | undefined; asyncDeploy?: boolean | undefined; } | undefined, context?: ",
{ {
"pluginId": "@kbn/core-http-request-handler-context-server", "pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "server", "scope": "server",
@ -11067,6 +11097,20 @@
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyClient.delete.$4.asyncDeploy",
"type": "CompoundType",
"tags": [],
"label": "asyncDeploy",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
"deprecated": false,
"trackAdoption": false
} }
] ]
}, },

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet" title: "fleet"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin description: API docs for the fleet plugin
date: 2024-11-05 date: 2024-11-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
--- ---
import fleetObj from './fleet.devdocs.json'; 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 | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 1423 | 5 | 1300 | 80 | | 1426 | 5 | 1303 | 81 |
## Client ## Client

View file

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

View file

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

View file

@ -1810,7 +1810,7 @@
"label": "ArtifactsSchema", "label": "ArtifactsSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly application?: Readonly<{} & { path: string; label: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }" "{ readonly application?: Readonly<{} & { label: string; path: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
], ],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false, "deprecated": false,
@ -1984,7 +1984,7 @@
"section": "def-server.TutorialContext", "section": "def-server.TutorialContext",
"text": "TutorialContext" "text": "TutorialContext"
}, },
") => Readonly<{ artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" ") => Readonly<{ artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
], ],
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
"deprecated": false, "deprecated": false,
@ -2022,7 +2022,7 @@
"label": "TutorialSchema", "label": "TutorialSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" "{ readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { id: string; type: \"string\" | \"number\"; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
], ],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false, "deprecated": false,

View file

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

View file

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

View file

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

View file

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

View file

@ -78,7 +78,7 @@
"section": "def-common.ToolOptions", "section": "def-common.ToolOptions",
"text": "ToolOptions" "text": "ToolOptions"
}, },
"<string>>(options: ", "<string>, TStream extends boolean = false>(options: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
@ -86,15 +86,15 @@
"section": "def-common.ChatCompleteOptions", "section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions" "text": "ChatCompleteOptions"
}, },
"<TToolOptions>) => ", "<TToolOptions, TStream>) => ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionResponse", "section": "def-common.ChatCompleteCompositeResponse",
"text": "ChatCompletionResponse" "text": "ChatCompleteCompositeResponse"
}, },
"<TToolOptions>" "<TToolOptions, TStream>"
], ],
"path": "x-pack/plugins/inference/public/types.ts", "path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false, "deprecated": false,
@ -109,7 +109,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ connectorId: string; system?: string | undefined; messages: ", "{ connectorId: string; stream?: TStream | undefined; system?: string | undefined; messages: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
@ -141,31 +141,27 @@
"label": "output", "label": "output",
"description": [], "description": [],
"signature": [ "signature": [
"<TId extends string = string, TOutputSchema extends ToolSchemaTypeObject | undefined = ToolSchemaTypeObject | undefined>(id: TId, options: { connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ", "<TId extends string = string, TOutputSchema extends ",
"ToolSchemaTypeObject",
" | undefined = ",
"ToolSchemaTypeObject",
" | undefined, TStream extends boolean = false>(options: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message", "section": "def-common.OutputOptions",
"text": "Message" "text": "OutputOptions"
}, },
"[] | undefined; functionCalling?: ", "<TId, TOutputSchema, TStream>) => ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode", "section": "def-common.OutputCompositeResponse",
"text": "FunctionCallingMode" "text": "OutputCompositeResponse"
}, },
" | undefined; }) => ", "<TId, TOutputSchema, TStream>"
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputResponse",
"text": "OutputResponse"
},
"<TId, TOutputSchema>"
], ],
"path": "x-pack/plugins/inference/public/types.ts", "path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false, "deprecated": false,
@ -175,42 +171,19 @@
{ {
"parentPluginId": "inference", "parentPluginId": "inference",
"id": "def-public.InferencePublicStart.output.$1", "id": "def-public.InferencePublicStart.output.$1",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"TId"
],
"path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.output.$2",
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message", "section": "def-common.OutputOptions",
"text": "Message" "text": "OutputOptions"
}, },
"[] | undefined; functionCalling?: ", "<TId, TOutputSchema, TStream>"
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined; }"
], ],
"path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts", "path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts",
"deprecated": false, "deprecated": false,
@ -323,7 +296,7 @@
"section": "def-common.ToolOptions", "section": "def-common.ToolOptions",
"text": "ToolOptions" "text": "ToolOptions"
}, },
"<string>>(options: ", "<string>, TStream extends boolean = false>(options: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
@ -331,15 +304,15 @@
"section": "def-common.ChatCompleteOptions", "section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions" "text": "ChatCompleteOptions"
}, },
"<TToolOptions>) => ", "<TToolOptions, TStream>) => ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionResponse", "section": "def-common.ChatCompleteCompositeResponse",
"text": "ChatCompletionResponse" "text": "ChatCompleteCompositeResponse"
}, },
"<TToolOptions>" "<TToolOptions, TStream>"
], ],
"path": "x-pack/plugins/inference/server/types.ts", "path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false, "deprecated": false,
@ -354,7 +327,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ connectorId: string; system?: string | undefined; messages: ", "{ connectorId: string; stream?: TStream | undefined; system?: string | undefined; messages: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
@ -388,31 +361,27 @@
"\n`output` asks the LLM to generate a structured (JSON)\nresponse based on a schema and a prompt or conversation." "\n`output` asks the LLM to generate a structured (JSON)\nresponse based on a schema and a prompt or conversation."
], ],
"signature": [ "signature": [
"<TId extends string = string, TOutputSchema extends ToolSchemaTypeObject | undefined = ToolSchemaTypeObject | undefined>(id: TId, options: { connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ", "<TId extends string = string, TOutputSchema extends ",
"ToolSchemaTypeObject",
" | undefined = ",
"ToolSchemaTypeObject",
" | undefined, TStream extends boolean = false>(options: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message", "section": "def-common.OutputOptions",
"text": "Message" "text": "OutputOptions"
}, },
"[] | undefined; functionCalling?: ", "<TId, TOutputSchema, TStream>) => ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode", "section": "def-common.OutputCompositeResponse",
"text": "FunctionCallingMode" "text": "OutputCompositeResponse"
}, },
" | undefined; }) => ", "<TId, TOutputSchema, TStream>"
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputResponse",
"text": "OutputResponse"
},
"<TId, TOutputSchema>"
], ],
"path": "x-pack/plugins/inference/server/types.ts", "path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false, "deprecated": false,
@ -422,42 +391,19 @@
{ {
"parentPluginId": "inference", "parentPluginId": "inference",
"id": "def-server.InferenceClient.output.$1", "id": "def-server.InferenceClient.output.$1",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"TId"
],
"path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "inference",
"id": "def-server.InferenceClient.output.$2",
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
{ {
"pluginId": "@kbn/inference-common", "pluginId": "@kbn/inference-common",
"scope": "common", "scope": "common",
"docId": "kibKbnInferenceCommonPluginApi", "docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message", "section": "def-common.OutputOptions",
"text": "Message" "text": "OutputOptions"
}, },
"[] | undefined; functionCalling?: ", "<TId, TOutputSchema, TStream>"
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined; }"
], ],
"path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts", "path": "x-pack/packages/ai-infra/inference-common/src/output/api.ts",
"deprecated": false, "deprecated": false,
@ -671,6 +617,89 @@
"returnComment": [], "returnComment": [],
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "inference",
"id": "def-common.createOutputApi",
"type": "Function",
"tags": [],
"label": "createOutputApi",
"description": [],
"signature": [
"(chatCompleteApi: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteAPI",
"text": "ChatCompleteAPI"
},
") => ({ id, connectorId, input, schema, system, previousMessages, functionCalling, stream, }: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputOptions",
"text": "OutputOptions"
},
"<string, ",
"ToolSchemaTypeObject",
" | undefined, boolean>) => ",
"Observable",
"<{ type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
"; id: string; content: string; output?: undefined; } | { id: string; output: ",
"AugmentedRequired",
"<{ [x: string]: string | number | boolean | ",
"AugmentedRequired",
"<any, never> | FromToolSchemaArray<ToolSchemaTypeArray> | undefined; }, never> | undefined; content: string; type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
"; }> | Promise<{ id: string; content: string; output: ",
"AugmentedRequired",
"<{ [x: string]: string | number | boolean | ",
"AugmentedRequired",
"<any, never> | FromToolSchemaArray<ToolSchemaTypeArray> | undefined; }, never> | undefined; }>"
],
"path": "x-pack/plugins/inference/common/create_output_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "inference",
"id": "def-common.createOutputApi.$1",
"type": "Function",
"tags": [],
"label": "chatCompleteApi",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteAPI",
"text": "ChatCompleteAPI"
}
],
"path": "x-pack/plugins/inference/common/create_output_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{ {
"parentPluginId": "inference", "parentPluginId": "inference",
"id": "def-common.generateFakeToolCallId", "id": "def-common.generateFakeToolCallId",

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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