Merge branch 'main' into canvas/fix-return-path

elastic · Nov 24, 2021 · 215c4b6 · 215c4b6
2 parents c20a6f3 + 147042e
commit 215c4b6
Show file tree

Hide file tree

Showing 108 changed files with 1,102 additions and 699 deletions.
diff --git a/.buildkite/scripts/common/env.sh b/.buildkite/scripts/common/env.sh
@@ -34,6 +34,8 @@ export TEST_BROWSER_HEADLESS=1
 
 export ELASTIC_APM_ENVIRONMENT=ci
 export ELASTIC_APM_TRANSACTION_SAMPLE_RATE=0.1
+export ELASTIC_APM_SERVER_URL=https://kibana-ci-apm.apm.us-central1.gcp.cloud.es.io
+export ELASTIC_APM_SECRET_TOKEN=7YKhoXsO4MzjhXjx2c
 
 if is_pr; then
   if [[ "${GITHUB_PR_LABELS:-}" == *"ci:collect-apm"* ]]; then

diff --git a/.buildkite/scripts/steps/checks/type_check_plugin_public_api_docs.sh b/.buildkite/scripts/steps/checks/type_check_plugin_public_api_docs.sh
@@ -11,6 +11,9 @@ checks-reporter-with-killswitch "Build TS Refs" \
     --no-cache \
     --force
 
+set +e;
+echo "--- running check types and build api docs in parallel";
+
 checks-reporter-with-killswitch "Check Types" \
   node scripts/type_check &> target/check_types.log &
 check_types_pid=$!

diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json
@@ -122,13 +122,14 @@
                 "type": "Function",
                 "tags": [],
                 "label": "register",
-                "description": [],
+                "description": [
+                  "/**\n     * Attempts to register the provided component, with the ability to optionally allow\n     * the component to override an existing one.\n     *\n     * If the intent is to override, then `allowOverride` must be set to true, otherwise an exception is thrown.\n     *\n     * @param id the id of the component to register\n     * @param component the component\n     * @param allowOverride (default: false) - optional flag to allow this component to override a previously registered component\n     */"
+                ],
                 "signature": [
                   "(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
                 ],
                 "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                 "deprecated": false,
-                "returnComment": [],
                 "children": [
                   {
                     "parentPluginId": "advancedSettings",
@@ -138,10 +139,11 @@
                     "label": "id",
                     "description": [],
                     "signature": [
-                      "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
+                      "Id"
                     ],
                     "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
-                    "deprecated": false
+                    "deprecated": false,
+                    "isRequired": true
                   },
                   {
                     "parentPluginId": "advancedSettings",
@@ -151,10 +153,11 @@
                     "label": "component",
                     "description": [],
                     "signature": [
-                      "React.ComponentClass<Record<string, any> | undefined, any> | React.FunctionComponent<Record<string, any> | undefined>"
+                      "React.ComponentType<Record<string, any> | undefined>"
                     ],
                     "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
-                    "deprecated": false
+                    "deprecated": false,
+                    "isRequired": true
                   },
                   {
                     "parentPluginId": "advancedSettings",
@@ -163,10 +166,15 @@
                     "tags": [],
                     "label": "allowOverride",
                     "description": [],
+                    "signature": [
+                      "boolean"
+                    ],
                     "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
-                    "deprecated": false
+                    "deprecated": false,
+                    "isRequired": true
                   }
-                ]
+                ],
+                "returnComment": []
               }
             ]
           },
@@ -199,13 +207,14 @@
                 "type": "Function",
                 "tags": [],
                 "label": "get",
-                "description": [],
+                "description": [
+                  "/**\n     * Retrieve a registered component by its ID.\n     * If the component does not exist, then an exception is thrown.\n     *\n     * @param id the ID of the component to retrieve\n     */"
+                ],
                 "signature": [
                   "(id: Id) => React.ComponentType<Record<string, any> | undefined>"
                 ],
                 "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                 "deprecated": false,
-                "returnComment": [],
                 "children": [
                   {
                     "parentPluginId": "advancedSettings",
@@ -215,12 +224,14 @@
                     "label": "id",
                     "description": [],
                     "signature": [
-                      "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
+                      "Id"
                     ],
                     "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
-                    "deprecated": false
+                    "deprecated": false,
+                    "isRequired": true
                   }
-                ]
+                ],
+                "returnComment": []
               }
             ]
           }

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
 
 | Public API count  | Any count | Items lacking comments | Missing exports | 
 |-------------------|-----------|------------------------|-----------------|
-| 23 | 0 | 22 | 1 |
+| 23 | 0 | 20 | 1 |
 
 ## Client
 

diff --git a/api_docs/charts.json b/api_docs/charts.json
@@ -944,7 +944,7 @@
             "id": "def-public.ColorMap.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: RawColorSchema",
+            "label": "[key: string]: RawColorSchema",
             "description": [],
             "signature": [
               "[key: string]:  ",
@@ -3292,7 +3292,7 @@
             "id": "def-common.ColorMap.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: RawColorSchema",
+            "label": "[key: string]: RawColorSchema",
             "description": [],
             "signature": [
               "[key: string]:  ",

diff --git a/api_docs/core.json b/api_docs/core.json
@@ -949,7 +949,7 @@
             "id": "def-public.Capabilities.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: Record<string, boolean | Record<string, boolean>>",
+            "label": "[key: string]: Record<string, boolean | Record<string, boolean>>",
             "description": [
               "Custom capabilities, registered by plugins."
             ],
@@ -4459,7 +4459,7 @@
             "id": "def-public.SavedObjectAttributes.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: SavedObjectAttribute",
+            "label": "[key: string]: SavedObjectAttribute",
             "description": [],
             "signature": [
               "[key: string]:  ",
@@ -5915,7 +5915,7 @@
             "id": "def-public.SavedObjectsMigrationVersion.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[pluginName: string}]: string",
+            "label": "[pluginName: string]: string",
             "description": [],
             "signature": [
               "[pluginName: string]:  string"
@@ -6375,7 +6375,7 @@
             "id": "def-public.UiSettingsState.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: Pick<UiSettingsParams<unknown>, \"name\" | \"type\" | \"description\" | \"options\" | \"order\" | \"value\" | \"category\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"metric\"> & UserProvidedValues<...>",
+            "label": "[key: string]: Pick<UiSettingsParams<unknown>, \"name\" | \"type\" | \"description\" | \"options\" | \"order\" | \"value\" | \"category\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"metric\"> & UserProvidedValues<...>",
             "description": [],
             "signature": [
               "[key: string]:  Pick<",
@@ -8353,7 +8353,7 @@
             "id": "def-server.Capabilities.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: Record<string, boolean | Record<string, boolean>>",
+            "label": "[key: string]: Record<string, boolean | Record<string, boolean>>",
             "description": [
               "Custom capabilities, registered by plugins."
             ],
@@ -16090,7 +16090,7 @@
             "id": "def-server.SavedObjectAttributes.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: SavedObjectAttribute",
+            "label": "[key: string]: SavedObjectAttribute",
             "description": [],
             "signature": [
               "[key: string]:  ",
@@ -16164,7 +16164,7 @@
             "id": "def-server.SavedObjectsMigrationVersion.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[pluginName: string}]: string",
+            "label": "[pluginName: string]: string",
             "description": [],
             "signature": [
               "[pluginName: string]:  string"

diff --git a/api_docs/core_http.json b/api_docs/core_http.json
@@ -196,7 +196,7 @@
             "id": "def-public.HttpFetchQuery.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[key: string}]: string | number | boolean | string[] | number[] | boolean[] | null | undefined",
+            "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined",
             "description": [
               "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n  | string\n  | number\n  | boolean\n  | Array<string | number | boolean>\n  | undefined\n  | null;"
             ],
@@ -293,7 +293,7 @@
             "id": "def-public.HttpHeadersInit.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[name: string}]: any",
+            "label": "[name: string]: any",
             "description": [],
             "signature": [
               "[name: string]:  any"

diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json
@@ -9734,7 +9734,7 @@
             "id": "def-server.SavedObjectMigrationMap.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[version: string}]: SavedObjectMigrationFn<any, any>",
+            "label": "[version: string]: SavedObjectMigrationFn<any, any>",
             "description": [],
             "signature": [
               "[version: string]:  ",
@@ -13259,7 +13259,7 @@
             "id": "def-server.SavedObjectsMappingProperties.Unnamed",
             "type": "IndexSignature",
             "tags": [],
-            "label": "[field: string}]: SavedObjectsFieldMapping",
+            "label": "[field: string]: SavedObjectsFieldMapping",
             "description": [],
             "signature": [
               "[field: string]:  ",

diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json
@@ -2872,7 +2872,7 @@
                 "id": "def-common.migratePanelsTo730.$4.Unnamed",
                 "type": "IndexSignature",
                 "tags": [],
-                "label": "[key: string}]: SerializableRecord",
+                "label": "[key: string]: SerializableRecord",
                 "description": [],
                 "signature": [
                   "[key: string]:  ",