Skip to content

Commit

Permalink
Fix deprecations being incorrectly counted (#128985)
Browse files Browse the repository at this point in the history 
* Adjust logic to fix overcounting bad deprecations

* Update api docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
  • Loading branch information
@stacey-gammon @kibanamachine
stacey-gammon and kibanamachine authored Mar 31, 2022
1 parent 1f91eb9 commit 1310210
Show file tree
Hide file tree
Showing 235 changed files with 18,340 additions and 11,312 deletions.
2 changes: 1 addition & 1 deletion 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-03-28
date: 2022-03-30
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 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-03-28
date: 2022-03-30
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
253 changes: 250 additions & 3 deletions api_docs/alerting.devdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2792,7 +2792,7 @@
">; getExecutionLogForRule: ({ id, dateStart, dateEnd, filter, page, perPage, sort, }: ",
"GetExecutionLogByIdParams",
") => Promise<",
"IExecutionLogResult",
"IExecutionLogWithErrorsResult",
">; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise<void>; unsnooze: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
"MuteOptions",
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
Expand Down Expand Up @@ -3732,6 +3732,19 @@
"path": "x-pack/plugins/alerting/common/alert.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertExecutionStatus.numberOfScheduledActions",
"type": "number",
"tags": [],
"label": "numberOfScheduledActions",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/alert.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertExecutionStatus.metrics",
Expand Down Expand Up @@ -4302,6 +4315,212 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog",
"type": "Interface",
"tags": [],
"label": "IExecutionLog",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.timestamp",
"type": "string",
"tags": [],
"label": "timestamp",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.duration_ms",
"type": "number",
"tags": [],
"label": "duration_ms",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.status",
"type": "string",
"tags": [],
"label": "status",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_active_alerts",
"type": "number",
"tags": [],
"label": "num_active_alerts",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_new_alerts",
"type": "number",
"tags": [],
"label": "num_new_alerts",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_recovered_alerts",
"type": "number",
"tags": [],
"label": "num_recovered_alerts",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_triggered_actions",
"type": "number",
"tags": [],
"label": "num_triggered_actions",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_succeeded_actions",
"type": "number",
"tags": [],
"label": "num_succeeded_actions",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.num_errored_actions",
"type": "number",
"tags": [],
"label": "num_errored_actions",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.total_search_duration_ms",
"type": "number",
"tags": [],
"label": "total_search_duration_ms",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.es_search_duration_ms",
"type": "number",
"tags": [],
"label": "es_search_duration_ms",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.schedule_delay_ms",
"type": "number",
"tags": [],
"label": "schedule_delay_ms",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLog.timed_out",
"type": "boolean",
"tags": [],
"label": "timed_out",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLogResult",
"type": "Interface",
"tags": [],
"label": "IExecutionLogResult",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLogResult.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IExecutionLogResult.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionLog",
"text": "IExecutionLog"
},
"[]"
],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.IntervalSchedule",
Expand Down Expand Up @@ -4393,7 +4612,7 @@
"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; triggeredActionsStatus?: string | undefined; }; }"
"{ 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
Expand Down Expand Up @@ -5027,6 +5246,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ExecutionLogSortFields",
"type": "Type",
"tags": [],
"label": "ExecutionLogSortFields",
"description": [],
"signature": [
"\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\""
],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.INTERNAL_BASE_ALERTING_API_PATH",
Expand Down Expand Up @@ -5184,7 +5417,7 @@
"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; triggeredActionsStatus?: string | undefined; }; }"
"{ 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,
Expand Down Expand Up @@ -5360,6 +5593,20 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.executionLogSortableColumns",
"type": "Object",
"tags": [],
"label": "executionLogSortableColumns",
"description": [],
"signature": [
"readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\"]"
],
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.rawAlertInstance",
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-03-28
date: 2022-03-30
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 |
|-------------------|-----------|------------------------|-----------------|
| 301 | 0 | 293 | 21 |
| 323 | 0 | 315 | 21 |

## Client

Expand Down
Loading

0 comments on commit 1310210

Please sign in to comment.