Skip to content

Commit

Permalink
Merge branch 'main' into track-adhoc-usage
Browse files Browse the repository at this point in the history
  • Loading branch information
jughosta authored Nov 17, 2022
2 parents 4b6e717 + e01649e commit acf61ca
Show file tree
Hide file tree
Showing 1,570 changed files with 33,880 additions and 10,065 deletions.
3 changes: 2 additions & 1 deletion .backportrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"repoName": "kibana",
"targetBranchChoices": [
"main",
"8.6",
"8.5",
"8.4",
"8.3",
Expand Down Expand Up @@ -42,7 +43,7 @@
"backport"
],
"branchLabelMapping": {
"^v8.6.0$": "main",
"^v8.7.0$": "main",
"^v(\\d+).(\\d+).\\d+$": "$1.$2"
},
"autoMerge": true,
Expand Down
2 changes: 1 addition & 1 deletion .buildkite/scripts/steps/build_api_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ if [[ "${PUBLISH_API_DOCS_CHANGES:-}" == "true" ]]; then

git remote add kibanamachine https://github.com/kibanamachine/kibana.git
git push -u kibanamachine "$branch"
prUrl=$(gh pr create --repo elastic/kibana --title "[api-docs] $(date +%F) Daily api_docs build" --body "Generated by $BUILDKITE_BUILD_URL" --label "release_note:skip" --label "backport:auto-version")
prUrl=$(gh pr create --repo elastic/kibana --title "[api-docs] $(date +%F) Daily api_docs build" --body "Generated by $BUILDKITE_BUILD_URL" --label "release_note:skip" --label "docs")
echo "Opened PR: $prUrl"
gh pr merge --repo elastic/kibana --auto --squash "$prUrl"

Expand Down
2 changes: 1 addition & 1 deletion api_docs/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2022-11-15
date: 2022-11-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
date: 2022-11-15
date: 2022-11-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
Expand Down
56 changes: 56 additions & 0 deletions api_docs/aiops.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,47 @@
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetection",
"type": "Function",
"tags": [],
"label": "ChangePointDetection",
"description": [
"\nLazy-wrapped LogCategorizationAppStateProps React component"
],
"signature": [
"(props: React.PropsWithChildren<",
"LogCategorizationAppStateProps",
">) => JSX.Element"
],
"path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetection.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [
"- properties specifying the data on which to run the analysis."
],
"signature": [
"React.PropsWithChildren<",
"LogCategorizationAppStateProps",
">"
],
"path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.ExplainLogRateSpikes",
Expand Down Expand Up @@ -154,6 +195,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-common.CHANGE_POINT_DETECTION_ENABLED",
"type": "boolean",
"tags": [],
"label": "CHANGE_POINT_DETECTION_ENABLED",
"description": [],
"signature": [
"false"
],
"path": "x-pack/plugins/aiops/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-common.PLUGIN_ID",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/aiops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
date: 2022-11-15
date: 2022-11-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 0 | 2 |
| 12 | 0 | 1 | 2 |

## Client

Expand Down
77 changes: 66 additions & 11 deletions api_docs/alerting.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ",
"[]; throttle?: string | null | undefined; consumer: string; alertTypeId: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
Expand All @@ -82,7 +82,7 @@
"section": "def-common.MappedParams",
"text": "MappedParams"
},
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ",
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
Expand Down Expand Up @@ -2761,7 +2761,7 @@
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; } | { operation: \"set\"; field: \"throttle\"; value: string | null; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ",
"; } | { operation: \"set\"; field: \"throttle\"; value: string | null | undefined; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ",
{
"pluginId": "alerting",
"scope": "common",
Expand Down Expand Up @@ -2994,7 +2994,23 @@
"section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule"
},
"<Params>>; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; muteAll: ({ id }: { id: string; }) => Promise<void>; getAlertState: ({ id }: { id: string; }) => Promise<void | { 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; }>; getAlertSummary: ({ id, dateStart, numberOfExecutions, }: ",
"<Params>>; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; clone: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(id: string, { newId }: { newId?: string | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>>; muteAll: ({ id }: { id: string; }) => Promise<void>; getAlertState: ({ id }: { id: string; }) => Promise<void | { 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; }>; getAlertSummary: ({ id, dateStart, numberOfExecutions, }: ",
"GetAlertSummaryParams",
") => Promise<",
{
Expand Down Expand Up @@ -3049,7 +3065,7 @@
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; getRuleExecutionKPI: ({ id, dateStart, dateEnd, filter }: ",
"GetRuleExecutionKPIParams",
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; bulkDeleteRules: (options: ",
"BulkDeleteOptions",
"BulkOptions",
") => Promise<{ errors: ",
{
"pluginId": "alerting",
Expand Down Expand Up @@ -3090,7 +3106,17 @@
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeSchedule, }: { id: string; snoozeSchedule: ",
"[]; total: number; }>; bulkEnableRules: (options: ",
"BulkOptions",
") => Promise<{ errors: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]; total: number; taskIdsFailedToBeEnabled: string[]; }>; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeSchedule, }: { id: string; snoozeSchedule: ",
{
"pluginId": "alerting",
"scope": "common",
Expand Down Expand Up @@ -3897,7 +3923,7 @@
"label": "throttle",
"description": [],
"signature": [
"string | null"
"string | null | undefined"
],
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
"deprecated": false,
Expand Down Expand Up @@ -5038,7 +5064,7 @@
"label": "throttle",
"description": [],
"signature": [
"string | null"
"string | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
Expand All @@ -5063,7 +5089,7 @@
"label": "notifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null"
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
Expand Down Expand Up @@ -5274,6 +5300,20 @@
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAction.frequency",
"type": "Object",
"tags": [],
"label": "frequency",
"description": [],
"signature": [
"{ summary: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; throttle: string | null; } | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
Expand Down Expand Up @@ -6967,7 +7007,7 @@
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ",
"[]; throttle?: string | null | undefined; consumer: string; alertTypeId: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
Expand All @@ -6983,7 +7023,7 @@
"section": "def-common.MappedParams",
"text": "MappedParams"
},
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ",
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
Expand Down Expand Up @@ -7286,6 +7326,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleNotifyWhenTypeValues",
"type": "Object",
"tags": [],
"label": "RuleNotifyWhenTypeValues",
"description": [],
"signature": [
"readonly [\"onActionGroupChange\", \"onActiveAlert\", \"onThrottleInterval\"]"
],
"path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ruleParamsSchema",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/alerting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2022-11-15
date: 2022-11-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 415 | 0 | 406 | 27 |
| 417 | 0 | 408 | 27 |

## Client

Expand Down
Loading

0 comments on commit acf61ca

Please sign in to comment.