Merge branch 'main' into d/2022-01-24-version-type-support

elastic · Jan 28, 2022 · 88b4c45 · 88b4c45
2 parents a5790d6 + 0ee514b
commit 88b4c45
Show file tree

Hide file tree

Showing 767 changed files with 17,470 additions and 17,941 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -184,6 +184,8 @@
 /x-pack/test/functional_with_es_ssl/apps/ml/ @elastic/ml-ui
 /x-pack/test/alerting_api_integration/spaces_only/tests/alerting/ml_rule_types/ @elastic/ml-ui
 /x-pack/test/alerting_api_integration/spaces_only/tests/alerting/transform_rule_types/ @elastic/ml-ui
+/x-pack/test/screenshot_creation/apps/ml_docs @elastic/ml-ui
+/x-pack/test/screenshot_creation/services/ml_screenshots.ts @elastic/ml-ui
 
 # ML team owns and maintains the transform plugin despite it living in the Data management section.
 /x-pack/plugins/transform/  @elastic/ml-ui

diff --git a/api_docs/actions.json → api_docs/actions.devdocs.json b/api_docs/actions.json → api_docs/actions.devdocs.json
@@ -709,7 +709,7 @@
         "label": "ActionParamsType",
         "description": [],
         "signature": [
-          "{ readonly message: string; readonly level: \"error\" | \"info\" | \"trace\" | \"debug\" | \"warn\" | \"fatal\"; }"
+          "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
         ],
         "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
         "deprecated": false,

diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -8,7 +8,7 @@ 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';
+import actionsObj from './actions.devdocs.json';
 
 
 

diff --git a/api_docs/advanced_settings.json → api_docs/advanced_settings.devdocs.json b/api_docs/advanced_settings.json → api_docs/advanced_settings.devdocs.json
diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -8,7 +8,7 @@ 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';
+import advancedSettingsObj from './advanced_settings.devdocs.json';
 
 
 

diff --git a/api_docs/alerting.json → api_docs/alerting.devdocs.json b/api_docs/alerting.json → api_docs/alerting.devdocs.json
@@ -41,7 +41,15 @@
             "label": "alert",
             "description": [],
             "signature": [
-              "{ id: string; name: string; tags: string[]; enabled: boolean; params: never; actions: ",
+              "{ id: string; monitoring?: ",
+              {
+                "pluginId": "alerting",
+                "scope": "common",
+                "docId": "kibAlertingPluginApi",
+                "section": "def-common.RuleMonitoring",
+                "text": "RuleMonitoring"
+              },
+              " | undefined; name: string; tags: string[]; enabled: boolean; params: never; actions: ",
               {
                 "pluginId": "alerting",
                 "scope": "common",
@@ -770,6 +778,63 @@
       }
     ],
     "functions": [
+      {
+        "parentPluginId": "alerting",
+        "id": "def-server.createAbortableEsClientFactory",
+        "type": "Function",
+        "tags": [],
+        "label": "createAbortableEsClientFactory",
+        "description": [],
+        "signature": [
+          "(opts: ",
+          "CreateAbortableEsClientFactoryOpts",
+          ") => { asInternalUser: { search: <TDocument = unknown, TAggregations = Record<string, ",
+          "AggregationsAggregate",
+          ">>(query: ",
+          "SearchRequest",
+          " | ",
+          "SearchRequest",
+          ", options?: ",
+          "TransportRequestOptions",
+          " | undefined) => Promise<",
+          "TransportResult",
+          "<",
+          "SearchResponse",
+          "<TDocument, TAggregations>, unknown>>; }; asCurrentUser: { search: <TDocument = unknown, TAggregations = Record<string, ",
+          "AggregationsAggregate",
+          ">>(query: ",
+          "SearchRequest",
+          " | ",
+          "SearchRequest",
+          ", options?: ",
+          "TransportRequestOptions",
+          " | undefined) => Promise<",
+          "TransportResult",
+          "<",
+          "SearchResponse",
+          "<TDocument, TAggregations>, unknown>>; }; }"
+        ],
+        "path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-server.createAbortableEsClientFactory.$1",
+            "type": "Object",
+            "tags": [],
+            "label": "opts",
+            "description": [],
+            "signature": [
+              "CreateAbortableEsClientFactoryOpts"
+            ],
+            "path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts",
+            "deprecated": false,
+            "isRequired": true
+          }
+        ],
+        "returnComment": [],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-server.getEsErrorMessage",
@@ -912,6 +977,16 @@
             "path": "x-pack/plugins/alerting/server/types.ts",
             "deprecated": false
           },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-server.AlertExecutorOptions.executionId",
+            "type": "string",
+            "tags": [],
+            "label": "executionId",
+            "description": [],
+            "path": "x-pack/plugins/alerting/server/types.ts",
+            "deprecated": false
+          },
           {
             "parentPluginId": "alerting",
             "id": "def-server.AlertExecutorOptions.startedAt",
@@ -2484,7 +2559,7 @@
             "section": "def-server.PartialAlert",
             "text": "PartialAlert"
           },
-          "<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 }: ",
+          "<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, }: ",
           "GetAlertSummaryParams",
           ") => Promise<",
           {
@@ -3205,6 +3280,26 @@
             ],
             "path": "x-pack/plugins/alerting/common/alert.ts",
             "deprecated": false
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.Alert.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/alert.ts",
+            "deprecated": false
           }
         ],
         "initialIsOpen": false
@@ -3910,6 +4005,43 @@
         ],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-common.RuleMonitoring",
+        "type": "Interface",
+        "tags": [],
+        "label": "RuleMonitoring",
+        "description": [],
+        "signature": [
+          {
+            "pluginId": "alerting",
+            "scope": "common",
+            "docId": "kibAlertingPluginApi",
+            "section": "def-common.RuleMonitoring",
+            "text": "RuleMonitoring"
+          },
+          " extends ",
+          "SavedObjectAttributes"
+        ],
+        "path": "x-pack/plugins/alerting/common/alert.ts",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.RuleMonitoring.execution",
+            "type": "Object",
+            "tags": [],
+            "label": "execution",
+            "description": [],
+            "signature": [
+              "{ history: { success: boolean; timestamp: number; }[]; calculated_metrics: { success_ratio: number; }; }"
+            ],
+            "path": "x-pack/plugins/alerting/common/alert.ts",
+            "deprecated": false
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-common.RuleType",
@@ -4532,7 +4664,15 @@
         "label": "SanitizedAlert",
         "description": [],
         "signature": [
-          "{ id: string; name: string; tags: string[]; enabled: boolean; params: Params; actions: ",
+          "{ id: string; monitoring?: ",
+          {
+            "pluginId": "alerting",
+            "scope": "common",
+            "docId": "kibAlertingPluginApi",
+            "section": "def-common.RuleMonitoring",
+            "text": "RuleMonitoring"
+          },
+          " | undefined; name: string; tags: string[]; enabled: boolean; params: Params; actions: ",
           {
             "pluginId": "alerting",
             "scope": "common",

diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
@@ -8,7 +8,7 @@ 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';
+import alertingObj from './alerting.devdocs.json';
 
 
 
@@ -18,7 +18,7 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 277 | 0 | 269 | 18 |
+| 283 | 0 | 275 | 19 |
 
 ## Client