Add a new file to list deprecations that are due, and by team (#124056)

* Add another file to track deprecations due by team * update docs * add link to new page * Update api docs after merging master
elastic · Jan 31, 2022 · 41c7521 · 41c7521
1 parent 857b205
commit 41c7521
Show file tree

Hide file tree

Showing 207 changed files with 1,806 additions and 909 deletions.
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: 2020-11-16
+date: 2022-01-31
 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: 2020-11-16
+date: 2022-01-31
 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/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: 2020-11-16
+date: 2022-01-31
 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: 2020-11-16
+date: 2022-01-31
 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: 2020-11-16
+date: 2022-01-31
 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.devdocs.json b/api_docs/bfetch.devdocs.json
@@ -86,6 +86,20 @@
           }
         ],
         "initialIsOpen": false
+      },
+      {
+        "parentPluginId": "bfetch",
+        "id": "def-public.DISABLE_BFETCH",
+        "type": "string",
+        "tags": [],
+        "label": "DISABLE_BFETCH",
+        "description": [],
+        "signature": [
+          "\"bfetch:disable\""
+        ],
+        "path": "src/plugins/bfetch/common/constants.ts",
+        "deprecated": false,
+        "initialIsOpen": false
       }
     ],
     "objects": [],
@@ -1319,6 +1333,20 @@
     ],
     "enums": [],
     "misc": [
+      {
+        "parentPluginId": "bfetch",
+        "id": "def-common.DISABLE_BFETCH",
+        "type": "string",
+        "tags": [],
+        "label": "DISABLE_BFETCH",
+        "description": [],
+        "signature": [
+          "\"bfetch:disable\""
+        ],
+        "path": "src/plugins/bfetch/common/constants.ts",
+        "deprecated": false,
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "bfetch",
         "id": "def-common.DISABLE_BFETCH_COMPRESSION",

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: 2020-11-16
+date: 2022-01-31
 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.
 ---
@@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 76 | 1 | 67 | 2 |
+| 78 | 1 | 69 | 2 |
 
 ## Client
 

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: 2020-11-16
+date: 2022-01-31
 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: 2020-11-16
+date: 2022-01-31
 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.devdocs.json b/api_docs/charts.devdocs.json
@@ -285,9 +285,9 @@
           },
           ", xAccessor: ",
           "Accessor",
-          " | ",
+          "<D> | ",
           "AccessorFn",
-          ") => ({ x: selectedRange }: ",
+          "<D, any>) => ({ x: selectedRange }: ",
           "XYBrushEvent",
           ") => ",
           {
@@ -330,8 +330,9 @@
             "description": [],
             "signature": [
               "Accessor",
-              " | ",
-              "AccessorFn"
+              "<D> | ",
+              "AccessorFn",
+              "<D, any>"
             ],
             "path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
             "deprecated": false,
@@ -361,19 +362,19 @@
           },
           ", xAccessor: ",
           "Accessor",
-          " | ",
+          "<never> | ",
           "AccessorFn",
-          ", splitSeriesAccessorFnMap?: Map<string | number, ",
+          "<any, any>, splitSeriesAccessorFnMap?: Map<string | number, ",
           "AccessorFn",
-          "> | undefined, splitChartAccessor?: ",
+          "<any, any>> | undefined, splitChartAccessor?: ",
           "Accessor",
-          " | ",
+          "<never> | ",
           "AccessorFn",
-          " | undefined, negate?: boolean) => (points: [",
+          "<any, any> | undefined, negate?: boolean) => (points: [",
           "GeometryValue",
           ", ",
           "XYChartSeriesIdentifier",
-          "][]) => ",
+          "<any>][]) => ",
           {
             "pluginId": "charts",
             "scope": "public",
@@ -414,8 +415,9 @@
             "description": [],
             "signature": [
               "Accessor",
-              " | ",
-              "AccessorFn"
+              "<never> | ",
+              "AccessorFn",
+              "<any, any>"
             ],
             "path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
             "deprecated": false,
@@ -433,7 +435,7 @@
             "signature": [
               "Map<string | number, ",
               "AccessorFn",
-              "> | undefined"
+              "<any, any>> | undefined"
             ],
             "path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
             "deprecated": false,
@@ -448,9 +450,9 @@
             "description": [],
             "signature": [
               "Accessor",
-              " | ",
+              "<never> | ",
               "AccessorFn",
-              " | undefined"
+              "<any, any> | undefined"
             ],
             "path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
             "deprecated": false,
@@ -494,13 +496,13 @@
           },
           ") => ({ splitAccessors, ...rest }: ",
           "XYChartSeriesIdentifier",
-          ", splitSeriesAccessorFnMap?: Map<string | number, ",
+          "<any>, splitSeriesAccessorFnMap?: Map<string | number, ",
           "AccessorFn",
-          "> | undefined, splitChartAccessor?: ",
+          "<any, any>> | undefined, splitChartAccessor?: ",
           "Accessor",
-          " | ",
+          "<never> | ",
           "AccessorFn",
-          " | undefined, negate?: boolean) => ",
+          "<any, any> | undefined, negate?: boolean) => ",
           {
             "pluginId": "charts",
             "scope": "public",
@@ -680,7 +682,7 @@
         "signature": [
           "(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ",
           "TooltipValue",
-          ") => string | JSX.Element"
+          "<any>) => string | JSX.Element"
         ],
         "path": "src/plugins/charts/public/static/components/endzones.tsx",
         "deprecated": false,

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: 2020-11-16
+date: 2022-01-31
 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.devdocs.json b/api_docs/cloud.devdocs.json
@@ -9,7 +9,9 @@
         "type": "Function",
         "tags": [],
         "label": "Chat",
-        "description": [],
+        "description": [
+          "\nA lazily-loaded component that will display a trigger that will allow the user to chat with a\nhuman operator when the service is enabled; otherwise, it renders nothing."
+        ],
         "signature": [
           "() => JSX.Element"
         ],
@@ -128,7 +130,9 @@
             "type": "Object",
             "tags": [],
             "label": "chat",
-            "description": [],
+            "description": [
+              "Configuration to enable live chat in Cloud-enabled instances of Kibana."
+            ],
             "signature": [
               "{ enabled: boolean; chatURL: string; }"
             ],

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: 2020-11-16
+date: 2022-01-31
 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.
 ---
@@ -18,13 +18,16 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 22 | 0 | 22 | 0 |
+| 28 | 0 | 23 | 0 |
 
 ## Client
 
 ### Setup
 <DocDefinitionList data={[cloudObj.client.setup]}/>
 
+### Functions
+<DocDefinitionList data={cloudObj.client.functions}/>
+
 ### Interfaces
 <DocDefinitionList data={cloudObj.client.interfaces}/>
 

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: 2020-11-16
+date: 2022-01-31
 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.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: 2020-11-16
+date: 2022-01-31
 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.
 ---