[api-docs] 2024-12-03 Daily api_docs build (elastic#202630)

Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/910
JoseLuisGJ · Dec 3, 2024 · bc4ead1 · bc4ead1
1 parent 2ace6ff
commit bc4ead1
Show file tree

Hide file tree

Showing 794 changed files with 3,697 additions and 5,069 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
@@ -3270,20 +3270,6 @@
             "deprecated": false,
             "trackAdoption": false
           },
-          {
-            "parentPluginId": "actions",
-            "id": "def-server.ActionTypeExecutorOptions.isEphemeral",
-            "type": "CompoundType",
-            "tags": [],
-            "label": "isEphemeral",
-            "description": [],
-            "signature": [
-              "boolean | undefined"
-            ],
-            "path": "x-pack/plugins/actions/server/types.ts",
-            "deprecated": false,
-            "trackAdoption": false
-          },
           {
             "parentPluginId": "actions",
             "id": "def-server.ActionTypeExecutorOptions.taskInfo",
@@ -3838,16 +3824,6 @@
           "ExecuteOptions",
           "[]) => Promise<",
           "ExecutionResponse",
-          ">; ephemeralEnqueuedExecution: (options: ",
-          "ExecuteOptions",
-          ") => Promise<",
-          {
-            "pluginId": "taskManager",
-            "scope": "server",
-            "docId": "kibTaskManagerPluginApi",
-            "section": "def-server.RunNowResult",
-            "text": "RunNowResult"
-          },
           ">; listTypes: ({ featureId, includeSystemActionTypes, }?: ",
           "ListTypesParams",
           ") => Promise<",

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
 ---
 import actionsObj from './actions.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 322 | 0 | 316 | 37 |
+| 321 | 0 | 315 | 37 |
 
 ## Client
 

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-02
+date: 2024-12-03
 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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
 ---
 import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
 ---
 import aiopsObj from './aiops.devdocs.json';

diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json
@@ -4715,21 +4715,6 @@
         "trackAdoption": false,
         "initialIsOpen": false
       },
-      {
-        "parentPluginId": "alerting",
-        "id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT",
-        "type": "number",
-        "tags": [],
-        "label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT",
-        "description": [],
-        "signature": [
-          "10"
-        ],
-        "path": "x-pack/plugins/alerting/server/config.ts",
-        "deprecated": false,
-        "trackAdoption": false,
-        "initialIsOpen": false
-      },
       {
         "parentPluginId": "alerting",
         "id": "def-server.ECS_COMPONENT_TEMPLATE_NAME",

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
 ---
 import alertingObj from './alerting.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 881 | 1 | 849 | 50 |
+| 880 | 1 | 848 | 50 |
 
 ## Client
 

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 ---
 import apmObj from './apm.devdocs.json';

diff --git a/api_docs/apm_data_access.devdocs.json b/api_docs/apm_data_access.devdocs.json
@@ -441,6 +441,78 @@
     ],
     "functions": [],
     "interfaces": [
+      {
+        "parentPluginId": "apmDataAccess",
+        "id": "def-server.ApmDataAccessPrivilegesCheck",
+        "type": "Interface",
+        "tags": [],
+        "label": "ApmDataAccessPrivilegesCheck",
+        "description": [],
+        "path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "children": [
+          {
+            "parentPluginId": "apmDataAccess",
+            "id": "def-server.ApmDataAccessPrivilegesCheck.request",
+            "type": "Object",
+            "tags": [],
+            "label": "request",
+            "description": [],
+            "signature": [
+              {
+                "pluginId": "@kbn/core-http-server",
+                "scope": "server",
+                "docId": "kibKbnCoreHttpServerPluginApi",
+                "section": "def-server.KibanaRequest",
+                "text": "KibanaRequest"
+              },
+              "<unknown, unknown, unknown, any>"
+            ],
+            "path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          },
+          {
+            "parentPluginId": "apmDataAccess",
+            "id": "def-server.ApmDataAccessPrivilegesCheck.security",
+            "type": "Object",
+            "tags": [],
+            "label": "security",
+            "description": [],
+            "signature": [
+              {
+                "pluginId": "@kbn/security-plugin-types-server",
+                "scope": "server",
+                "docId": "kibKbnSecurityPluginTypesServerPluginApi",
+                "section": "def-server.SecurityPluginStart",
+                "text": "SecurityPluginStart"
+              },
+              " | undefined"
+            ],
+            "path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          },
+          {
+            "parentPluginId": "apmDataAccess",
+            "id": "def-server.ApmDataAccessPrivilegesCheck.getApmIndices",
+            "type": "Function",
+            "tags": [],
+            "label": "getApmIndices",
+            "description": [],
+            "signature": [
+              "() => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
+            ],
+            "path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "children": [],
+            "returnComment": []
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "apmDataAccess",
         "id": "def-server.ApmDataAccessServicesParams",
@@ -2293,12 +2365,42 @@
           "label": "getApmIndices",
           "description": [],
           "signature": [
-            "() => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
+            "(soClient: ",
+            {
+              "pluginId": "@kbn/core-saved-objects-api-server",
+              "scope": "server",
+              "docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
+              "section": "def-server.SavedObjectsClientContract",
+              "text": "SavedObjectsClientContract"
+            },
+            ") => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
           ],
           "path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
           "deprecated": false,
           "trackAdoption": false,
-          "children": [],
+          "children": [
+            {
+              "parentPluginId": "apmDataAccess",
+              "id": "def-server.ApmDataAccessPluginSetup.getApmIndices.$1",
+              "type": "Object",
+              "tags": [],
+              "label": "soClient",
+              "description": [],
+              "signature": [
+                {
+                  "pluginId": "@kbn/core-saved-objects-api-server",
+                  "scope": "server",
+                  "docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
+                  "section": "def-server.SavedObjectsClientContract",
+                  "text": "SavedObjectsClientContract"
+                }
+              ],
+              "path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
+              "deprecated": false,
+              "trackAdoption": false,
+              "isRequired": true
+            }
+          ],
           "returnComment": []
         },
         {
@@ -2402,7 +2504,56 @@
       "path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
       "deprecated": false,
       "trackAdoption": false,
-      "children": [],
+      "children": [
+        {
+          "parentPluginId": "apmDataAccess",
+          "id": "def-server.ApmDataAccessPluginStart.hasPrivileges",
+          "type": "Function",
+          "tags": [],
+          "label": "hasPrivileges",
+          "description": [],
+          "signature": [
+            "(params: Pick<",
+            {
+              "pluginId": "apmDataAccess",
+              "scope": "server",
+              "docId": "kibApmDataAccessPluginApi",
+              "section": "def-server.ApmDataAccessPrivilegesCheck",
+              "text": "ApmDataAccessPrivilegesCheck"
+            },
+            ", \"request\">) => Promise<boolean>"
+          ],
+          "path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
+          "deprecated": false,
+          "trackAdoption": false,
+          "children": [
+            {
+              "parentPluginId": "apmDataAccess",
+              "id": "def-server.ApmDataAccessPluginStart.hasPrivileges.$1",
+              "type": "Object",
+              "tags": [],
+              "label": "params",
+              "description": [],
+              "signature": [
+                "Pick<",
+                {
+                  "pluginId": "apmDataAccess",
+                  "scope": "server",
+                  "docId": "kibApmDataAccessPluginApi",
+                  "section": "def-server.ApmDataAccessPrivilegesCheck",
+                  "text": "ApmDataAccessPrivilegesCheck"
+                },
+                ", \"request\">"
+              ],
+              "path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
+              "deprecated": false,
+              "trackAdoption": false,
+              "isRequired": true
+            }
+          ],
+          "returnComment": []
+        }
+      ],
       "lifecycle": "start",
       "initialIsOpen": true
     }

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
 ---
 import apmDataAccessObj from './apm_data_access.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 86 | 0 | 86 | 3 |
+| 93 | 0 | 93 | 3 |
 
 ## Server
 

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 ---
 import bannersObj from './banners.devdocs.json';

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

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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
 ---
 import canvasObj from './canvas.devdocs.json';

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-02
+date: 2024-12-03
 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-02
+date: 2024-12-03
 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-02
+date: 2024-12-03
 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-02
+date: 2024-12-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
 ---
 import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';