[api-docs] 2024-12-24 Daily api_docs build (#205127)

Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/931
elastic · Dec 24, 2024 · 6d9cfe2 · 6d9cfe2
1 parent 6d5be74
commit 6d9cfe2
Show file tree

Hide file tree

Showing 882 changed files with 10,035 additions and 5,714 deletions.
diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
 title: "actions"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the actions plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
 ---
 import actionsObj from './actions.devdocs.json';

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
 title: "advancedSettings"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the advancedSettings plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
 ---
 import advancedSettingsObj from './advanced_settings.devdocs.json';

diff --git a/api_docs/ai_assistant_management_selection.mdx b/api_docs/ai_assistant_management_selection.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
 title: "aiAssistantManagementSelection"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the aiAssistantManagementSelection plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
 ---
 import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

diff --git a/api_docs/aiops.devdocs.json b/api_docs/aiops.devdocs.json
@@ -254,13 +254,7 @@
               "\nUsed to check capabilities for links to other plugins.\n`application.currentAppId$` is used to close the log pattern analysis flyout\nwhen user navigates out of the current plugin."
             ],
             "signature": [
-              {
-                "pluginId": "@kbn/core-application-browser",
-                "scope": "public",
-                "docId": "kibKbnCoreApplicationBrowserPluginApi",
-                "section": "def-public.ApplicationStart",
-                "text": "ApplicationStart"
-              }
+              "ApplicationStart"
             ],
             "path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
             "deprecated": false,

diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
 title: "aiops"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the aiops plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
 ---
 import aiopsObj from './aiops.devdocs.json';

diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
 title: "alerting"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the alerting plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
 ---
 import alertingObj from './alerting.devdocs.json';

diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
 title: "apm"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the apm plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 ---
 import apmObj from './apm.devdocs.json';

diff --git a/api_docs/apm_data_access.mdx b/api_docs/apm_data_access.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
 title: "apmDataAccess"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the apmDataAccess plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
 ---
 import apmDataAccessObj from './apm_data_access.devdocs.json';

diff --git a/api_docs/asset_inventory.devdocs.json b/api_docs/asset_inventory.devdocs.json
@@ -31,7 +31,42 @@
       "path": "x-pack/solutions/security/plugins/asset_inventory/public/types.ts",
       "deprecated": false,
       "trackAdoption": false,
-      "children": [],
+      "children": [
+        {
+          "parentPluginId": "assetInventory",
+          "id": "def-public.AssetInventoryPluginStart.getAssetInventoryPage",
+          "type": "Function",
+          "tags": [],
+          "label": "getAssetInventoryPage",
+          "description": [],
+          "signature": [
+            "(assetInventoryStartDeps: ",
+            "AppPluginStartDependencies",
+            ") => JSX.Element"
+          ],
+          "path": "x-pack/solutions/security/plugins/asset_inventory/public/types.ts",
+          "deprecated": false,
+          "trackAdoption": false,
+          "children": [
+            {
+              "parentPluginId": "assetInventory",
+              "id": "def-public.AssetInventoryPluginStart.getAssetInventoryPage.$1",
+              "type": "Object",
+              "tags": [],
+              "label": "assetInventoryStartDeps",
+              "description": [],
+              "signature": [
+                "AppPluginStartDependencies"
+              ],
+              "path": "x-pack/solutions/security/plugins/asset_inventory/public/types.ts",
+              "deprecated": false,
+              "trackAdoption": false,
+              "isRequired": true
+            }
+          ],
+          "returnComment": []
+        }
+      ],
       "lifecycle": "start",
       "initialIsOpen": true
     }

diff --git a/api_docs/asset_inventory.mdx b/api_docs/asset_inventory.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetInventory
 title: "assetInventory"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the assetInventory plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetInventory']
 ---
 import assetInventoryObj from './asset_inventory.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 6 | 0 | 6 | 0 |
+| 8 | 0 | 8 | 1 |
 
 ## Client
 

diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
 title: "banners"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the banners plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 ---
 import bannersObj from './banners.devdocs.json';

diff --git a/api_docs/canvas.devdocs.json b/api_docs/canvas.devdocs.json
@@ -11,7 +11,7 @@
         "tags": [],
         "label": "WithKibanaProps",
         "description": [],
-        "path": "x-pack/plugins/canvas/public/index.ts",
+        "path": "x-pack/platform/plugins/private/canvas/public/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "children": [
@@ -37,7 +37,7 @@
               "CanvasServices",
               "; }; }"
             ],
-            "path": "x-pack/plugins/canvas/public/index.ts",
+            "path": "x-pack/platform/plugins/private/canvas/public/index.ts",
             "deprecated": false,
             "trackAdoption": false
           }
@@ -60,7 +60,7 @@
       "signature": [
         "CanvasApi"
       ],
-      "path": "x-pack/plugins/canvas/public/plugin.tsx",
+      "path": "x-pack/platform/plugins/private/canvas/public/plugin.tsx",
       "deprecated": false,
       "trackAdoption": false,
       "lifecycle": "setup",
@@ -76,7 +76,7 @@
       "signature": [
         "void"
       ],
-      "path": "x-pack/plugins/canvas/public/plugin.tsx",
+      "path": "x-pack/platform/plugins/private/canvas/public/plugin.tsx",
       "deprecated": false,
       "trackAdoption": false,
       "lifecycle": "start",
@@ -107,7 +107,7 @@
         "signature": [
           "\"CANVAS_APP_LOCATOR\""
         ],
-        "path": "x-pack/plugins/canvas/common/locator.ts",
+        "path": "x-pack/platform/plugins/private/canvas/common/locator.ts",
         "deprecated": false,
         "trackAdoption": false,
         "initialIsOpen": false
@@ -137,7 +137,7 @@
           },
           ">"
         ],
-        "path": "x-pack/plugins/canvas/common/locator.ts",
+        "path": "x-pack/platform/plugins/private/canvas/common/locator.ts",
         "deprecated": false,
         "trackAdoption": false,
         "initialIsOpen": false
@@ -152,7 +152,7 @@
         "signature": [
           "{ view: \"workpadPDF\"; id: string; page: number; }"
         ],
-        "path": "x-pack/plugins/canvas/common/locator.ts",
+        "path": "x-pack/platform/plugins/private/canvas/common/locator.ts",
         "deprecated": false,
         "trackAdoption": false,
         "initialIsOpen": false
@@ -166,7 +166,7 @@
         "tags": [],
         "label": "UI_SETTINGS",
         "description": [],
-        "path": "x-pack/plugins/canvas/common/index.ts",
+        "path": "x-pack/platform/plugins/private/canvas/common/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "children": [
@@ -177,7 +177,7 @@
             "tags": [],
             "label": "ENABLE_LABS_UI",
             "description": [],
-            "path": "x-pack/plugins/canvas/common/index.ts",
+            "path": "x-pack/platform/plugins/private/canvas/common/index.ts",
             "deprecated": false,
             "trackAdoption": false
           }

diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
 title: "canvas"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the canvas plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
 ---
 import canvasObj from './canvas.devdocs.json';

diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json
@@ -47,21 +47,9 @@
         "description": [],
         "signature": [
           "<T extends ",
-          {
-            "pluginId": "@kbn/core-application-browser",
-            "scope": "public",
-            "docId": "kibKbnCoreApplicationBrowserPluginApi",
-            "section": "def-public.AppDeepLink",
-            "text": "AppDeepLink"
-          },
+          "AppDeepLink",
           "<string> = ",
-          {
-            "pluginId": "@kbn/core-application-browser",
-            "scope": "public",
-            "docId": "kibKbnCoreApplicationBrowserPluginApi",
-            "section": "def-public.AppDeepLink",
-            "text": "AppDeepLink"
-          },
+          "AppDeepLink",
           "<string>>({ basePath, extend, }: { basePath?: string | undefined; extend?: Partial<Record<",
           {
             "pluginId": "cases",
@@ -589,7 +577,7 @@
             "CustomFieldTypes",
             ".TOGGLE; value: boolean | null; } | { key: string; type: ",
             "CustomFieldTypes",
-            ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+            ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
             {
               "pluginId": "@kbn/cases-components",
               "scope": "common",
@@ -2054,7 +2042,7 @@
           "CustomFieldTypes",
           ".TOGGLE; value: boolean | null; } | { key: string; type: ",
           "CustomFieldTypes",
-          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
           {
             "pluginId": "@kbn/cases-components",
             "scope": "common",
@@ -2452,7 +2440,7 @@
           "CustomFieldTypes",
           ".TOGGLE; value: boolean | null; } | { key: string; type: ",
           "CustomFieldTypes",
-          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
           {
             "pluginId": "@kbn/cases-components",
             "scope": "common",
@@ -2703,7 +2691,7 @@
           "CustomFieldTypes",
           ".TOGGLE; value: boolean | null; } | { key: string; type: ",
           "CustomFieldTypes",
-          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
           {
             "pluginId": "@kbn/cases-components",
             "scope": "common",
@@ -2892,7 +2880,7 @@
           "CustomFieldTypes",
           ".TOGGLE; value: boolean | null; } | { key: string; type: ",
           "CustomFieldTypes",
-          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: { id: string; createdAt: string; updatedAt: string | null; typeKey: string; value: string; description: string | null; }[]; status: ",
           {
             "pluginId": "@kbn/cases-components",
             "scope": "common",
@@ -3102,7 +3090,7 @@
           "CustomFieldTypes",
           ".TOGGLE; value: boolean | null; } | { key: string; type: ",
           "CustomFieldTypes",
-          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; status: ",
+          ".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: { id: string; createdAt: string; updatedAt: string | null; typeKey: string; value: string; description: string | null; }[]; status: ",
           {
             "pluginId": "@kbn/cases-components",
             "scope": "common",

diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
 title: "cases"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cases plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
 ---
 import casesObj from './cases.devdocs.json';

diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
 title: "charts"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the charts plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
 ---
 import chartsObj from './charts.devdocs.json';

diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
 title: "cloud"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloud plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
 ---
 import cloudObj from './cloud.devdocs.json';

diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
 title: "cloudDataMigration"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloudDataMigration plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
 ---
 import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
 title: "cloudDefend"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloudDefend plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
 ---
 import cloudDefendObj from './cloud_defend.devdocs.json';

diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
 title: "cloudSecurityPosture"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloudSecurityPosture plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
 ---
 import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

diff --git a/api_docs/console.mdx b/api_docs/console.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
 title: "console"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the console plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
 ---
 import consoleObj from './console.devdocs.json';

diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
 title: "contentManagement"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the contentManagement plugin
-date: 2024-12-23
+date: 2024-12-24
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
 ---
 import contentManagementObj from './content_management.devdocs.json';