Skip to content

Commit e96915a

Browse files
kibanamachinekibanamachine
authored
[api-docs] 2025-01-08 Daily api_docs build (#205836)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/946
1 parent a4b1975 commit e96915a

File tree

937 files changed

+4000
-4572
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

937 files changed

+4000
-4572
lines changed

‎api_docs/actions.devdocs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"section": "def-public.ActionsPublicPluginSetup",
2828
"text": "ActionsPublicPluginSetup"
2929
},
30-
", void, object, object>"
30+
", void, never, never>"
3131
],
3232
"path": "x-pack/platform/plugins/shared/actions/public/plugin.ts",
3333
"deprecated": false,

‎api_docs/actions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
88
title: "actions"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the actions plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
1313
---
1414
import actionsObj from './actions.devdocs.json';

‎api_docs/advanced_settings.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
88
title: "advancedSettings"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the advancedSettings plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
1313
---
1414
import advancedSettingsObj from './advanced_settings.devdocs.json';

‎api_docs/ai_assistant_management_selection.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
88
title: "aiAssistantManagementSelection"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the aiAssistantManagementSelection plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
1313
---
1414
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

‎api_docs/aiops.devdocs.json‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -436,13 +436,7 @@
436436
"\nUI settings."
437437
],
438438
"signature": [
439-
{
440-
"pluginId": "@kbn/core-ui-settings-browser",
441-
"scope": "public",
442-
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
443-
"section": "def-public.IUiSettingsClient",
444-
"text": "IUiSettingsClient"
445-
}
439+
"IUiSettingsClient"
446440
],
447441
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
448442
"deprecated": false,
@@ -493,6 +487,22 @@
493487
"deprecated": false,
494488
"trackAdoption": false
495489
},
490+
{
491+
"parentPluginId": "aiops",
492+
"id": "def-public.AiopsAppContextValue.userProfile",
493+
"type": "Object",
494+
"tags": [],
495+
"label": "userProfile",
496+
"description": [
497+
"\nUser profile service."
498+
],
499+
"signature": [
500+
"UserProfileService"
501+
],
502+
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
503+
"deprecated": false,
504+
"trackAdoption": false
505+
},
496506
{
497507
"parentPluginId": "aiops",
498508
"id": "def-public.AiopsAppContextValue.share",

‎api_docs/aiops.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
88
title: "aiops"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the aiops plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
1313
---
1414
import aiopsObj from './aiops.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi
2121

2222
| Public API count | Any count | Items lacking comments | Missing exports |
2323
|-------------------|-----------|------------------------|-----------------|
24-
| 72 | 0 | 8 | 2 |
24+
| 73 | 0 | 8 | 2 |
2525

2626
## Client
2727

‎api_docs/alerting.devdocs.json‎

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2273,7 +2273,7 @@
22732273
"label": "getIndexTemplateFields",
22742274
"description": [],
22752275
"signature": [
2276-
"(alias: string, pattern: string) => ",
2276+
"(alias: string, patterns: string[]) => ",
22772277
"IndexTemplateFields"
22782278
],
22792279
"path": "x-pack/platform/plugins/shared/alerting/server/alerts_service/lib/data_stream_adapter.ts",
@@ -2298,12 +2298,12 @@
22982298
{
22992299
"parentPluginId": "alerting",
23002300
"id": "def-server.DataStreamAdapter.getIndexTemplateFields.$2",
2301-
"type": "string",
2301+
"type": "Array",
23022302
"tags": [],
2303-
"label": "pattern",
2303+
"label": "patterns",
23042304
"description": [],
23052305
"signature": [
2306-
"string"
2306+
"string[]"
23072307
],
23082308
"path": "x-pack/platform/plugins/shared/alerting/server/alerts_service/lib/data_stream_adapter.ts",
23092309
"deprecated": false,
@@ -3678,13 +3678,7 @@
36783678
"label": "uiSettingsClient",
36793679
"description": [],
36803680
"signature": [
3681-
{
3682-
"pluginId": "@kbn/core-ui-settings-server",
3683-
"scope": "server",
3684-
"docId": "kibKbnCoreUiSettingsServerPluginApi",
3685-
"section": "def-server.IUiSettingsClient",
3686-
"text": "IUiSettingsClient"
3687-
}
3681+
"IUiSettingsClient"
36883682
],
36893683
"path": "x-pack/platform/plugins/shared/alerting/server/types.ts",
36903684
"deprecated": false,
@@ -4367,7 +4361,7 @@
43674361
"section": "def-common.FilterStateStore",
43684362
"text": "FilterStateStore"
43694363
},
4370-
"; }> | 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\"; }>"
4364+
"; }> | 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?: (\"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\")[] | 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\"; }>"
43714365
],
43724366
"path": "x-pack/platform/plugins/shared/alerting/server/application/rule/methods/bulk_edit/types/bulk_edit_rules_options.ts",
43734367
"deprecated": false,
@@ -4684,7 +4678,7 @@
46844678
"section": "def-common.RuleTypeParams",
46854679
"text": "RuleTypeParams"
46864680
},
4687-
" = never>(params?: Readonly<{ options?: Readonly<{ page?: number | undefined; filter?: string | Record<string, any> | undefined; search?: string | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; hasReference?: Readonly<{} & { id: string; type: string; }> | undefined; fields?: string[] | undefined; ruleTypeIds?: string[] | undefined; consumers?: string[] | undefined; } & {}> | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; } & {}> | undefined) => Promise<",
4681+
" = never>(params?: Readonly<{ options?: Readonly<{ page?: number | undefined; filter?: string | Record<string, any> | undefined; search?: string | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; hasReference?: Readonly<{} & { id: string; type: string; }> | Readonly<{} & { id: string; type: string; }>[] | undefined; fields?: string[] | undefined; ruleTypeIds?: string[] | undefined; consumers?: string[] | undefined; } & {}> | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; } & {}> | undefined) => Promise<",
46884682
{
46894683
"pluginId": "alerting",
46904684
"scope": "server",
@@ -7336,13 +7330,7 @@
73367330
"label": "uiSettings",
73377331
"description": [],
73387332
"signature": [
7339-
{
7340-
"pluginId": "@kbn/core-ui-settings-server",
7341-
"scope": "server",
7342-
"docId": "kibKbnCoreUiSettingsServerPluginApi",
7343-
"section": "def-server.IUiSettingsClient",
7344-
"text": "IUiSettingsClient"
7345-
}
7333+
"IUiSettingsClient"
73467334
],
73477335
"path": "x-pack/platform/plugins/shared/alerting/common/maintenance_window.ts",
73487336
"deprecated": false,
@@ -11031,7 +11019,13 @@
1103111019
"description": [],
1103211020
"signature": [
1103311021
"Omit<",
11034-
"Options",
11022+
{
11023+
"pluginId": "@kbn/rrule",
11024+
"scope": "common",
11025+
"docId": "kibKbnRrulePluginApi",
11026+
"section": "def-common.Options",
11027+
"text": "Options"
11028+
},
1103511029
", \"dtstart\" | \"until\" | \"byweekday\" | \"wkst\"> & { dtstart: string; byweekday?: (string | number)[] | null | undefined; wkst?: ",
1103611030
{
1103711031
"pluginId": "@kbn/rrule",

‎api_docs/alerting.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
88
title: "alerting"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the alerting plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
1313
---
1414
import alertingObj from './alerting.devdocs.json';

‎api_docs/apm.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
88
title: "apm"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the apm plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
1313
---
1414
import apmObj from './apm.devdocs.json';

‎api_docs/apm_data_access.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
88
title: "apmDataAccess"
99
image: https://source.unsplash.com/400x175/?github
1010
description: API docs for the apmDataAccess plugin
11-
date: 2025-01-07
11+
date: 2025-01-08
1212
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
1313
---
1414
import apmDataAccessObj from './apm_data_access.devdocs.json';

0 commit comments

Comments
 (0)