Merge branch 'main' into 123372-flaky-test-runtime-fields

elastic · May 24, 2022 · da54b7d · da54b7d
2 parents ebf7cab + 577752a
commit da54b7d
Show file tree

Hide file tree

Showing 475 changed files with 27,229 additions and 17,750 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -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-26
+date: 2022-05-24
 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.
 ---
@@ -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 |
 |-------------------|-----------|------------------------|-----------------|
-| 195 | 0 | 191 | 11 |
+| 240 | 0 | 235 | 19 |
 
 ## Client
 
@@ -39,6 +39,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
 ### Functions
 <DocDefinitionList data={actionsObj.server.functions}/>
 
+### Classes
+<DocDefinitionList data={actionsObj.server.classes}/>
+
 ### Interfaces
 <DocDefinitionList data={actionsObj.server.interfaces}/>
 

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -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-26
+date: 2022-05-24
 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.
 ---

diff --git a/api_docs/aiops.devdocs.json b/api_docs/aiops.devdocs.json
@@ -0,0 +1,212 @@
+{
+  "id": "aiops",
+  "client": {
+    "classes": [],
+    "functions": [
+      {
+        "parentPluginId": "aiops",
+        "id": "def-public.ExplainLogRateSpikes",
+        "type": "Function",
+        "tags": [],
+        "label": "ExplainLogRateSpikes",
+        "description": [
+          "\nLazy-wrapped ExplainLogRateSpikes React component"
+        ],
+        "signature": [
+          "(props: React.PropsWithChildren<",
+          {
+            "pluginId": "aiops",
+            "scope": "public",
+            "docId": "kibAiopsPluginApi",
+            "section": "def-public.ExplainLogRateSpikesProps",
+            "text": "ExplainLogRateSpikesProps"
+          },
+          ">) => JSX.Element"
+        ],
+        "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "aiops",
+            "id": "def-public.ExplainLogRateSpikes.$1",
+            "type": "CompoundType",
+            "tags": [],
+            "label": "props",
+            "description": [
+              "- properties specifying the data on which to run the analysis."
+            ],
+            "signature": [
+              "React.PropsWithChildren<",
+              {
+                "pluginId": "aiops",
+                "scope": "public",
+                "docId": "kibAiopsPluginApi",
+                "section": "def-public.ExplainLogRateSpikesProps",
+                "text": "ExplainLogRateSpikesProps"
+              },
+              ">"
+            ],
+            "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
+            "deprecated": false,
+            "isRequired": true
+          }
+        ],
+        "returnComment": [],
+        "initialIsOpen": false
+      }
+    ],
+    "interfaces": [
+      {
+        "parentPluginId": "aiops",
+        "id": "def-public.ExplainLogRateSpikesProps",
+        "type": "Interface",
+        "tags": [],
+        "label": "ExplainLogRateSpikesProps",
+        "description": [
+          "\nExplainLogRateSpikes props require a data view."
+        ],
+        "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "aiops",
+            "id": "def-public.ExplainLogRateSpikesProps.dataView",
+            "type": "Object",
+            "tags": [],
+            "label": "dataView",
+            "description": [
+              "The data view to analyze."
+            ],
+            "signature": [
+              {
+                "pluginId": "dataViews",
+                "scope": "common",
+                "docId": "kibDataViewsPluginApi",
+                "section": "def-common.DataView",
+                "text": "DataView"
+              }
+            ],
+            "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx",
+            "deprecated": false
+          }
+        ],
+        "initialIsOpen": false
+      }
+    ],
+    "enums": [],
+    "misc": [],
+    "objects": [],
+    "start": {
+      "parentPluginId": "aiops",
+      "id": "def-public.AiopsPluginStart",
+      "type": "Type",
+      "tags": [],
+      "label": "AiopsPluginStart",
+      "description": [
+        "\naiops plugin public start contract"
+      ],
+      "signature": [
+        "void"
+      ],
+      "path": "x-pack/plugins/aiops/public/types.ts",
+      "deprecated": false,
+      "lifecycle": "start",
+      "initialIsOpen": true
+    }
+  },
+  "server": {
+    "classes": [],
+    "functions": [],
+    "interfaces": [],
+    "enums": [],
+    "misc": [],
+    "objects": [],
+    "setup": {
+      "parentPluginId": "aiops",
+      "id": "def-server.AiopsPluginSetup",
+      "type": "Interface",
+      "tags": [],
+      "label": "AiopsPluginSetup",
+      "description": [
+        "\naiops plugin server setup contract"
+      ],
+      "path": "x-pack/plugins/aiops/server/types.ts",
+      "deprecated": false,
+      "children": [],
+      "lifecycle": "setup",
+      "initialIsOpen": true
+    },
+    "start": {
+      "parentPluginId": "aiops",
+      "id": "def-server.AiopsPluginStart",
+      "type": "Interface",
+      "tags": [],
+      "label": "AiopsPluginStart",
+      "description": [
+        "\naiops plugin server start contract"
+      ],
+      "path": "x-pack/plugins/aiops/server/types.ts",
+      "deprecated": false,
+      "children": [],
+      "lifecycle": "start",
+      "initialIsOpen": true
+    }
+  },
+  "common": {
+    "classes": [],
+    "functions": [],
+    "interfaces": [],
+    "enums": [],
+    "misc": [
+      {
+        "parentPluginId": "aiops",
+        "id": "def-common.AIOPS_ENABLED",
+        "type": "boolean",
+        "tags": [],
+        "label": "AIOPS_ENABLED",
+        "description": [
+          "\nThis is an internal hard coded feature flag so we can easily turn on/off the\n\"Explain log rate spikes UI\" during development until the first release."
+        ],
+        "signature": [
+          "false"
+        ],
+        "path": "x-pack/plugins/aiops/common/index.ts",
+        "deprecated": false,
+        "initialIsOpen": false
+      },
+      {
+        "parentPluginId": "aiops",
+        "id": "def-common.PLUGIN_ID",
+        "type": "string",
+        "tags": [],
+        "label": "PLUGIN_ID",
+        "description": [
+          "\nPLUGIN_ID is used as a unique identifier for the aiops plugin"
+        ],
+        "signature": [
+          "\"aiops\""
+        ],
+        "path": "x-pack/plugins/aiops/common/index.ts",
+        "deprecated": false,
+        "initialIsOpen": false
+      },
+      {
+        "parentPluginId": "aiops",
+        "id": "def-common.PLUGIN_NAME",
+        "type": "string",
+        "tags": [],
+        "label": "PLUGIN_NAME",
+        "description": [
+          "\nPLUGIN_NAME is used as the display name for the aiops plugin"
+        ],
+        "signature": [
+          "\"AIOps\""
+        ],
+        "path": "x-pack/plugins/aiops/common/index.ts",
+        "deprecated": false,
+        "initialIsOpen": false
+      }
+    ],
+    "objects": []
+  }
+}
diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx
@@ -0,0 +1,46 @@
+---
+id: kibAiopsPluginApi
+slug: /kibana-dev-docs/api/aiops
+title: "aiops"
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the aiops plugin
+date: 2022-05-24
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
+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 aiopsObj from './aiops.devdocs.json';
+
+AIOps plugin maintained by ML team.
+
+Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin.
+
+**Code health stats**
+
+| Public API count  | Any count | Items lacking comments | Missing exports |
+|-------------------|-----------|------------------------|-----------------|
+| 11 | 0 | 0 | 0 |
+
+## Client
+
+### Start
+<DocDefinitionList data={[aiopsObj.client.start]}/>
+
+### Functions
+<DocDefinitionList data={aiopsObj.client.functions}/>
+
+### Interfaces
+<DocDefinitionList data={aiopsObj.client.interfaces}/>
+
+## Server
+
+### Setup
+<DocDefinitionList data={[aiopsObj.server.setup]}/>
+
+### Start
+<DocDefinitionList data={[aiopsObj.server.start]}/>
+
+## Common
+
+### Consts, variables and types
+<DocDefinitionList data={aiopsObj.common.misc}/>
+