Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stacey-gammon
stacey-gammon committed Jun 24, 2021
1 parent b70b34f commit f761adf
Show file tree
Hide file tree
Showing 155 changed files with 64,107 additions and 6,951 deletions.
4 changes: 2 additions & 2 deletions api_docs/actions.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -969,9 +969,9 @@
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>>; execute: ({ actionId, params, source, }: Pick<",
"<Record<string, unknown>>>; execute: ({ actionId, params, source, relatedSavedObjects, }: Pick<",
"ExecuteOptions",
"<unknown>, \"source\" | \"params\" | \"actionId\">) => Promise<",
"<unknown>, \"source\" | \"params\" | \"actionId\" | \"relatedSavedObjects\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
Expand Down
1 change: 0 additions & 1 deletion api_docs/actions.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import actionsObj from './actions.json';


Expand Down
1 change: 0 additions & 1 deletion api_docs/advanced_settings.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import advancedSettingsObj from './advanced_settings.json';


Expand Down
66 changes: 21 additions & 45 deletions api_docs/alerting.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,7 @@
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
"JsonObject"
],
"source": {
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
Expand Down Expand Up @@ -64,7 +58,7 @@
],
"label": "registerNavigation",
"description": [
"\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"
"\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 details view in Stack Management.\n"
],
"signature": [
"(applicationId: string, ruleType: string, handler: ",
Expand Down Expand Up @@ -133,13 +127,7 @@
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
"JsonObject"
],
"source": {
"path": "x-pack/plugins/alerting/public/plugin.ts",
Expand All @@ -156,7 +144,7 @@
"tags": [],
"label": "registerDefaultNavigation",
"description": [
"\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"
"\nRegister a customized view for all rule types with this application id. 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 details view in Stack Management.\n"
],
"signature": [
"(applicationId: string, handler: ",
Expand Down Expand Up @@ -210,13 +198,7 @@
"text": "Alert"
},
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
"JsonObject"
],
"source": {
"path": "x-pack/plugins/alerting/public/plugin.ts",
Expand Down Expand Up @@ -1255,7 +1237,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 85
"lineNumber": 87
},
"deprecated": false,
"children": [
Expand All @@ -1279,7 +1261,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 86
"lineNumber": 88
},
"deprecated": false,
"children": [
Expand All @@ -1302,7 +1284,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 94
"lineNumber": 96
},
"deprecated": false,
"isRequired": true
Expand All @@ -1322,7 +1304,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 105
"lineNumber": 107
},
"deprecated": false,
"children": [
Expand All @@ -1340,7 +1322,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 108
},
"deprecated": false,
"returnComment": [],
Expand Down Expand Up @@ -1374,7 +1356,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 107
"lineNumber": 109
},
"deprecated": false,
"children": [
Expand All @@ -1397,7 +1379,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 107
"lineNumber": 109
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -1427,7 +1409,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 108
"lineNumber": 110
},
"deprecated": false,
"children": [
Expand All @@ -1450,7 +1432,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 109
"lineNumber": 111
},
"deprecated": false,
"isRequired": true
Expand Down Expand Up @@ -1478,7 +1460,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 111
"lineNumber": 113
},
"deprecated": false,
"returnComment": [],
Expand Down Expand Up @@ -3199,7 +3181,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"lineNumber": 13
"lineNumber": 12
},
"deprecated": false,
"children": [
Expand All @@ -3211,17 +3193,11 @@
"label": "state",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
"JsonObject"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"lineNumber": 14
"lineNumber": 13
},
"deprecated": false
}
Expand Down Expand Up @@ -3396,7 +3372,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"lineNumber": 10
"lineNumber": 9
},
"deprecated": false,
"children": [
Expand All @@ -3409,7 +3385,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"lineNumber": 11
"lineNumber": 10
},
"deprecated": false
}
Expand Down Expand Up @@ -3670,7 +3646,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_navigation.ts",
"lineNumber": 16
"lineNumber": 15
},
"deprecated": false,
"initialIsOpen": false
Expand Down
3 changes: 1 addition & 2 deletions api_docs/alerting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import alertingObj from './alerting.json';


Expand All @@ -19,7 +18,7 @@ import alertingObj from './alerting.json';

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 213 | 0 | 213 | 15 |
| 214 | 0 | 206 | 14 |

## Client

Expand Down
Loading

0 comments on commit f761adf

Please sign in to comment.