Skip to content

Commit

Permalink
Update API docs (elastic#130999)
Browse files Browse the repository at this point in the history 
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
  • Loading branch information
@thomasneirynck @kibanamachine
2 people authored and Esteban Beltran committed May 4, 2022
1 parent 7eaf7ad commit eb47add
Show file tree
Hide file tree
Showing 307 changed files with 21,559 additions and 15,743 deletions.
1,086 changes: 1,042 additions & 44 deletions api_docs/actions.devdocs.json
View file

Large diffs are not rendered by default.

15 changes: 13 additions & 2 deletions api_docs/actions.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the actions plugin
date: 2022-04-05
date: 2022-04-26
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.
---
Expand All @@ -18,7 +18,15 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 127 | 0 | 127 | 10 |
| 195 | 0 | 191 | 11 |

## Client

### Setup
<DocDefinitionList data={[actionsObj.client.setup]}/>

### Classes
<DocDefinitionList data={actionsObj.client.classes}/>

## Server

Expand All @@ -39,6 +47,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q

## Common

### Objects
<DocDefinitionList data={actionsObj.common.objects}/>

### Functions
<DocDefinitionList data={actionsObj.common.functions}/>

Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the advancedSettings plugin
date: 2022-04-05
date: 2022-04-26
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.
---
Expand Down
170 changes: 17 additions & 153 deletions api_docs/alerting.devdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2456,20 +2456,6 @@
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RuleType.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"RuleTypeConfig",
" | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
Expand Down Expand Up @@ -3889,10 +3875,10 @@
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_scheduled_actions",
"id": "def-common.IExecutionLog.num_generated_actions",
"type": "number",
"tags": [],
"label": "num_scheduled_actions",
"label": "num_generated_actions",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
Expand Down Expand Up @@ -4547,72 +4533,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionRunResult",
"type": "Interface",
"tags": [],
"label": "RuleExecutionRunResult",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionRunResult.state",
"type": "CompoundType",
"tags": [],
"label": "state",
"description": [],
"signature": [
"{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; numberOfScheduledActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionRunResult.monitoring",
"type": "Object",
"tags": [],
"label": "monitoring",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionRunResult.schedule",
"type": "Object",
"tags": [],
"label": "schedule",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus",
Expand All @@ -4631,46 +4551,7 @@
"label": "status",
"description": [],
"signature": [
"\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.numberOfTriggeredActions",
"type": "number",
"tags": [],
"label": "numberOfTriggeredActions",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.numberOfScheduledActions",
"type": "number",
"tags": [],
"label": "numberOfScheduledActions",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.metrics",
"type": "Object",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
"{ numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; } | undefined"
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false
Expand Down Expand Up @@ -5103,6 +4984,17 @@
}
],
"enums": [
{
"parentPluginId": "alerting",
"id": "def-common.ActionsCompletion",
"type": "Enum",
"tags": [],
"label": "ActionsCompletion",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.HealthStatus",
Expand Down Expand Up @@ -5263,7 +5155,7 @@
"label": "ExecutionLogSortFields",
"description": [],
"signature": [
"\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_scheduled_actions\""
"\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_generated_actions\""
],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
Expand Down Expand Up @@ -5463,34 +5355,6 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionMetrics",
"type": "Type",
"tags": [],
"label": "RuleExecutionMetrics",
"description": [],
"signature": [
"{ numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionState",
"type": "Type",
"tags": [],
"label": "RuleExecutionState",
"description": [],
"signature": [
"{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; numberOfScheduledActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatuses",
Expand All @@ -5499,7 +5363,7 @@
"label": "RuleExecutionStatuses",
"description": [],
"signature": [
"\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\""
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
Expand Down Expand Up @@ -5750,7 +5614,7 @@
"label": "executionLogSortableColumns",
"description": [],
"signature": [
"readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_scheduled_actions\"]"
"readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_generated_actions\"]"
],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
Expand Down
4 changes: 2 additions & 2 deletions api_docs/alerting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the alerting plugin
date: 2022-04-05
date: 2022-04-26
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.
---
Expand All @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 334 | 0 | 325 | 20 |
| 325 | 0 | 316 | 19 |

## Client

Expand Down
Loading

0 comments on commit eb47add

Please sign in to comment.