Skip to content

Commit dc70df5

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into remote-clusters/new_layout
2 parents 0083fa7 + 970e9a0 commit dc70df5

921 files changed

Lines changed: 38657 additions & 10447 deletions

File tree

Some content is hidden

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

‎api_docs/actions.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import actionsObj from './actions.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 116 | 0 | 116 | 7 |
23+
1424
## Server
1525

1626
### Setup

‎api_docs/advanced_settings.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import advancedSettingsObj from './advanced_settings.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 23 | 0 | 22 | 1 |
23+
1424
## Client
1525

1626
### Setup

‎api_docs/alerting.json‎

Lines changed: 95 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,42 @@
55
"functions": [],
66
"interfaces": [],
77
"enums": [],
8-
"misc": [],
8+
"misc": [
9+
{
10+
"parentPluginId": "alerting",
11+
"id": "def-public.AlertNavigationHandler",
12+
"type": "Type",
13+
"tags": [],
14+
"label": "AlertNavigationHandler",
15+
"description": [
16+
"\nReturns information that can be used to navigate to a specific page to view the given rule.\n"
17+
],
18+
"signature": [
19+
"(alert: Pick<",
20+
{
21+
"pluginId": "alerting",
22+
"scope": "common",
23+
"docId": "kibAlertingPluginApi",
24+
"section": "def-common.Alert",
25+
"text": "Alert"
26+
},
27+
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
28+
{
29+
"pluginId": "kibanaUtils",
30+
"scope": "common",
31+
"docId": "kibKibanaUtilsPluginApi",
32+
"section": "def-common.JsonObject",
33+
"text": "JsonObject"
34+
}
35+
],
36+
"source": {
37+
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
38+
"lineNumber": 20
39+
},
40+
"deprecated": false,
41+
"initialIsOpen": false
42+
}
43+
],
944
"objects": [],
1045
"setup": {
1146
"parentPluginId": "alerting",
@@ -24,44 +59,58 @@
2459
"parentPluginId": "alerting",
2560
"id": "def-public.PluginSetupContract.registerNavigation",
2661
"type": "Function",
27-
"tags": [],
62+
"tags": [
63+
"throws"
64+
],
2865
"label": "registerNavigation",
29-
"description": [],
66+
"description": [
67+
"\nRegister a customized view of the particular rule type. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule view in Stack Management.\n"
68+
],
3069
"signature": [
31-
"(consumer: string, alertType: string, handler: ",
32-
"AlertNavigationHandler",
70+
"(applicationId: string, ruleType: string, handler: ",
71+
{
72+
"pluginId": "alerting",
73+
"scope": "public",
74+
"docId": "kibAlertingPluginApi",
75+
"section": "def-public.AlertNavigationHandler",
76+
"text": "AlertNavigationHandler"
77+
},
3378
") => void"
3479
],
3580
"source": {
3681
"path": "x-pack/plugins/alerting/public/plugin.ts",
37-
"lineNumber": 15
82+
"lineNumber": 30
3883
},
3984
"deprecated": false,
4085
"returnComment": [],
4186
"children": [
4287
{
4388
"parentPluginId": "alerting",
44-
"id": "def-public.consumer",
89+
"id": "def-public.applicationId",
4590
"type": "string",
4691
"tags": [],
47-
"label": "consumer",
48-
"description": [],
92+
"label": "applicationId",
93+
"description": [
94+
"The application id that the user should be navigated to, to view a particular alert in a custom way."
95+
],
4996
"source": {
5097
"path": "x-pack/plugins/alerting/public/plugin.ts",
51-
"lineNumber": 16
98+
"lineNumber": 31
5299
},
53100
"deprecated": false
54101
},
55102
{
56103
"parentPluginId": "alerting",
57-
"id": "def-public.alertType",
104+
"id": "def-public.ruleType",
58105
"type": "string",
59106
"tags": [],
60-
"label": "alertType",
61-
"description": [],
107+
"label": "ruleType",
108+
"description": [
109+
"The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more."
110+
],
62111
"source": {
63112
"path": "x-pack/plugins/alerting/public/plugin.ts",
64-
"lineNumber": 17
113+
"lineNumber": 32
65114
},
66115
"deprecated": false
67116
},
@@ -71,7 +120,9 @@
71120
"type": "Function",
72121
"tags": [],
73122
"label": "handler",
74-
"description": [],
123+
"description": [
124+
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
125+
],
75126
"signature": [
76127
"(alert: Pick<",
77128
{
@@ -81,15 +132,7 @@
81132
"section": "def-common.Alert",
82133
"text": "Alert"
83134
},
84-
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
85-
{
86-
"pluginId": "alerting",
87-
"scope": "common",
88-
"docId": "kibAlertingPluginApi",
89-
"section": "def-common.AlertType",
90-
"text": "AlertType"
91-
},
92-
"<\"default\", \"recovered\">) => string | ",
135+
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
93136
{
94137
"pluginId": "kibanaUtils",
95138
"scope": "common",
@@ -100,7 +143,7 @@
100143
],
101144
"source": {
102145
"path": "x-pack/plugins/alerting/public/plugin.ts",
103-
"lineNumber": 18
146+
"lineNumber": 33
104147
},
105148
"deprecated": false
106149
}
@@ -112,29 +155,39 @@
112155
"type": "Function",
113156
"tags": [],
114157
"label": "registerDefaultNavigation",
115-
"description": [],
158+
"description": [
159+
"\nRegister a customized view for all rule types. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule view in Stack Management.\n"
160+
],
116161
"signature": [
117-
"(consumer: string, handler: ",
118-
"AlertNavigationHandler",
162+
"(applicationId: string, handler: ",
163+
{
164+
"pluginId": "alerting",
165+
"scope": "public",
166+
"docId": "kibAlertingPluginApi",
167+
"section": "def-public.AlertNavigationHandler",
168+
"text": "AlertNavigationHandler"
169+
},
119170
") => void"
120171
],
121172
"source": {
122173
"path": "x-pack/plugins/alerting/public/plugin.ts",
123-
"lineNumber": 20
174+
"lineNumber": 46
124175
},
125176
"deprecated": false,
126177
"returnComment": [],
127178
"children": [
128179
{
129180
"parentPluginId": "alerting",
130-
"id": "def-public.consumer",
181+
"id": "def-public.applicationId",
131182
"type": "string",
132183
"tags": [],
133-
"label": "consumer",
134-
"description": [],
184+
"label": "applicationId",
185+
"description": [
186+
"The application id that the user should be navigated to, to view a particular alert in a custom way."
187+
],
135188
"source": {
136189
"path": "x-pack/plugins/alerting/public/plugin.ts",
137-
"lineNumber": 20
190+
"lineNumber": 46
138191
},
139192
"deprecated": false
140193
},
@@ -144,7 +197,9 @@
144197
"type": "Function",
145198
"tags": [],
146199
"label": "handler",
147-
"description": [],
200+
"description": [
201+
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
202+
],
148203
"signature": [
149204
"(alert: Pick<",
150205
{
@@ -154,15 +209,7 @@
154209
"section": "def-common.Alert",
155210
"text": "Alert"
156211
},
157-
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
158-
{
159-
"pluginId": "alerting",
160-
"scope": "common",
161-
"docId": "kibAlertingPluginApi",
162-
"section": "def-common.AlertType",
163-
"text": "AlertType"
164-
},
165-
"<\"default\", \"recovered\">) => string | ",
212+
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
166213
{
167214
"pluginId": "kibanaUtils",
168215
"scope": "common",
@@ -173,7 +220,7 @@
173220
],
174221
"source": {
175222
"path": "x-pack/plugins/alerting/public/plugin.ts",
176-
"lineNumber": 20
223+
"lineNumber": 46
177224
},
178225
"deprecated": false
179226
}
@@ -192,7 +239,7 @@
192239
"description": [],
193240
"source": {
194241
"path": "x-pack/plugins/alerting/public/plugin.ts",
195-
"lineNumber": 22
242+
"lineNumber": 48
196243
},
197244
"deprecated": false,
198245
"children": [
@@ -224,7 +271,7 @@
224271
],
225272
"source": {
226273
"path": "x-pack/plugins/alerting/public/plugin.ts",
227-
"lineNumber": 23
274+
"lineNumber": 49
228275
},
229276
"deprecated": false,
230277
"returnComment": [],
@@ -238,7 +285,7 @@
238285
"description": [],
239286
"source": {
240287
"path": "x-pack/plugins/alerting/public/plugin.ts",
241-
"lineNumber": 23
288+
"lineNumber": 49
242289
},
243290
"deprecated": false
244291
}
@@ -3857,7 +3904,7 @@
38573904
"label": "ReservedActionGroups",
38583905
"description": [],
38593906
"signature": [
3860-
"\"recovered\" | RecoveryActionGroupId"
3907+
"RecoveryActionGroupId | \"recovered\""
38613908
],
38623909
"source": {
38633910
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",

‎api_docs/alerting.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import alertingObj from './alerting.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 213 | 0 | 213 | 15 |
23+
1424
## Client
1525

1626
### Setup
@@ -19,6 +29,9 @@ import alertingObj from './alerting.json';
1929
### Start
2030
<DocDefinitionList data={[alertingObj.client.start]}/>
2131

32+
### Consts, variables and types
33+
<DocDefinitionList data={alertingObj.client.misc}/>
34+
2235
## Server
2336

2437
### Functions

‎api_docs/apm.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import apmObj from './apm.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 37 | 0 | 37 | 30 |
23+
1424
## Client
1525

1626
### Setup

‎api_docs/apm_oss.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import apmOssObj from './apm_oss.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 4 | 0 | 4 | 0 |
23+
1424
## Server
1525

1626
### Setup

‎api_docs/banners.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
1111

1212
import bannersObj from './banners.json';
1313

14+
15+
16+
17+
18+
**Code health stats**
19+
20+
| Public API count | Any count | Items lacking comments | Missing exports |
21+
|-------------------|-----------|------------------------|-----------------|
22+
| 9 | 0 | 9 | 0 |
23+
1424
## Common
1525

1626
### Interfaces

0 commit comments

Comments
 (0)