update docs (#133798)

elastic · Jun 7, 2022 · 7db3e58 · 7db3e58
1 parent 92569b4
commit 7db3e58
Show file tree

Hide file tree

Showing 290 changed files with 40,231 additions and 40,293 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
@@ -1593,7 +1593,7 @@
         "label": "ActionParamsType",
         "description": [],
         "signature": [
-          "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }"
+          "{ readonly source?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }"
         ],
         "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
         "deprecated": false,

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-05-24
+date: 2022-06-07
 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.
 ---

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-05-24
+date: 2022-06-07
 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.mdx b/api_docs/aiops.mdx
@@ -4,7 +4,7 @@ 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
+date: 2022-06-07
 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.
 ---

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

diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json
diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm
 title: "apm"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the apm plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 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/banners.mdx b/api_docs/banners.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners
 title: "banners"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the banners plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 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/bfetch.mdx b/api_docs/bfetch.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch
 title: "bfetch"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the bfetch plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
 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/canvas.mdx b/api_docs/canvas.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas
 title: "canvas"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the canvas plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
 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/cases.mdx b/api_docs/cases.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases
 title: "cases"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cases plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
 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/charts.mdx b/api_docs/charts.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts
 title: "charts"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the charts plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
 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/cloud.mdx b/api_docs/cloud.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud
 title: "cloud"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cloud plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
 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/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
 title: "cloudSecurityPosture"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cloudSecurityPosture plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
 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/console.mdx b/api_docs/console.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console
 title: "console"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the console plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
 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/controls.devdocs.json b/api_docs/controls.devdocs.json
@@ -3397,13 +3397,7 @@
           " | undefined; filters?: ",
           "Filter",
           "[] | undefined; timeRange?: ",
-          {
-            "pluginId": "data",
-            "scope": "common",
-            "docId": "kibDataQueryPluginApi",
-            "section": "def-common.TimeRange",
-            "text": "TimeRange"
-          },
+          "TimeRange",
           " | undefined; controlStyle?: ",
           "ControlStyle",
           " | undefined; ignoreParentSettings?: ",
@@ -4339,7 +4333,9 @@
         "type": "Type",
         "tags": [],
         "label": "PersistableControlGroupInput",
-        "description": [],
+        "description": [
+          "\nOnly parts of the Control Group Input should be persisted"
+        ],
         "signature": [
           "{ controlStyle: ",
           "ControlStyle",
@@ -4397,6 +4393,44 @@
         "deprecated": false,
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "controls",
+        "id": "def-common.SerializableControlGroupInput",
+        "type": "Type",
+        "tags": [],
+        "label": "SerializableControlGroupInput",
+        "description": [
+          "\nSome use cases need the Persistable Control Group Input to conform to the SerializableRecord format which requires string index signatures in any objects"
+        ],
+        "signature": [
+          "Omit<",
+          {
+            "pluginId": "controls",
+            "scope": "common",
+            "docId": "kibControlsPluginApi",
+            "section": "def-common.PersistableControlGroupInput",
+            "text": "PersistableControlGroupInput"
+          },
+          ", \"ignoreParentSettings\" | \"panels\"> & { panels: ",
+          {
+            "pluginId": "controls",
+            "scope": "common",
+            "docId": "kibControlsPluginApi",
+            "section": "def-common.ControlsPanels",
+            "text": "ControlsPanels"
+          },
+          " & ",
+          "SerializableRecord",
+          "; ignoreParentSettings: ",
+          "ParentIgnoreSettings",
+          " & ",
+          "SerializableRecord",
+          "; }"
+        ],
+        "path": "src/plugins/controls/common/control_group/types.ts",
+        "deprecated": false,
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "controls",
         "id": "def-common.TIME_SLIDER_CONTROL",

diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls
 title: "controls"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the controls plugin
-date: 2022-05-24
+date: 2022-06-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
 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 [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 205 | 0 | 199 | 7 |
+| 206 | 0 | 198 | 7 |
 
 ## Client