[api-docs] Daily api_docs build

elastic · Jan 7, 2025 · 7e2b234 · 7e2b234
1 parent 47b19ba
commit 7e2b234
Show file tree

Hide file tree

Showing 795 changed files with 1,359 additions and 932 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
@@ -2834,6 +2834,20 @@
             "deprecated": false,
             "trackAdoption": false
           },
+          {
+            "parentPluginId": "actions",
+            "id": "def-server.ActionType.subFeature",
+            "type": "string",
+            "tags": [],
+            "label": "subFeature",
+            "description": [],
+            "signature": [
+              "\"endpointSecurity\" | undefined"
+            ],
+            "path": "x-pack/platform/plugins/shared/actions/server/types.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          },
           {
             "parentPluginId": "actions",
             "id": "def-server.ActionType.getKibanaPrivileges",
@@ -2844,7 +2858,15 @@
               "\nAdditional Kibana privileges to be checked by the actions framework.\nUse it if you want to perform extra authorization checks based on a Kibana feature.\nFor example, you can define the privileges a users needs to have to execute\na Case or OsQuery system action.\n\nThe list of the privileges follows the Kibana privileges format usually generated with `security.authz.actions.*.get(...)`.\n\nIt only works with system actions and only when executing an action.\nFor all other scenarios they will be ignored"
             ],
             "signature": [
-              "((args?: { params?: Params | undefined; } | undefined) => string[]) | undefined"
+              "((args?: { params?: Params | undefined; source?: ",
+              {
+                "pluginId": "actions",
+                "scope": "server",
+                "docId": "kibActionsPluginApi",
+                "section": "def-server.ActionExecutionSourceType",
+                "text": "ActionExecutionSourceType"
+              },
+              " | undefined; } | undefined) => string[]) | undefined"
             ],
             "path": "x-pack/platform/plugins/shared/actions/server/types.ts",
             "deprecated": false,
@@ -2874,6 +2896,27 @@
                     "path": "x-pack/platform/plugins/shared/actions/server/types.ts",
                     "deprecated": false,
                     "trackAdoption": false
+                  },
+                  {
+                    "parentPluginId": "actions",
+                    "id": "def-server.ActionType.getKibanaPrivileges.$1.source",
+                    "type": "CompoundType",
+                    "tags": [],
+                    "label": "source",
+                    "description": [],
+                    "signature": [
+                      {
+                        "pluginId": "actions",
+                        "scope": "server",
+                        "docId": "kibActionsPluginApi",
+                        "section": "def-server.ActionExecutionSourceType",
+                        "text": "ActionExecutionSourceType"
+                      },
+                      " | undefined"
+                    ],
+                    "path": "x-pack/platform/plugins/shared/actions/server/types.ts",
+                    "deprecated": false,
+                    "trackAdoption": false
                   }
                 ]
               }
@@ -3665,7 +3708,20 @@
         "initialIsOpen": false
       }
     ],
-    "enums": [],
+    "enums": [
+      {
+        "parentPluginId": "actions",
+        "id": "def-server.ActionExecutionSourceType",
+        "type": "Enum",
+        "tags": [],
+        "label": "ActionExecutionSourceType",
+        "description": [],
+        "path": "x-pack/platform/plugins/shared/actions/server/lib/action_execution_source.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      }
+    ],
     "misc": [
       {
         "parentPluginId": "actions",
@@ -5108,6 +5164,20 @@
             "path": "x-pack/platform/plugins/shared/actions/common/types.ts",
             "deprecated": false,
             "trackAdoption": false
+          },
+          {
+            "parentPluginId": "actions",
+            "id": "def-common.ActionType.subFeature",
+            "type": "string",
+            "tags": [],
+            "label": "subFeature",
+            "description": [],
+            "signature": [
+              "\"endpointSecurity\" | undefined"
+            ],
+            "path": "x-pack/platform/plugins/shared/actions/common/types.ts",
+            "deprecated": false,
+            "trackAdoption": false
           }
         ],
         "initialIsOpen": false
@@ -5918,6 +5988,21 @@
         "trackAdoption": false,
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "actions",
+        "id": "def-common.EndpointSecurityConnectorFeatureId",
+        "type": "string",
+        "tags": [],
+        "label": "EndpointSecurityConnectorFeatureId",
+        "description": [],
+        "signature": [
+          "\"endpointSecurity\""
+        ],
+        "path": "x-pack/platform/plugins/shared/actions/common/connector_feature_config.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "actions",
         "id": "def-common.ExecutionLogSortFields",
@@ -6119,6 +6204,21 @@
         "trackAdoption": false,
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "actions",
+        "id": "def-common.SubFeature",
+        "type": "Type",
+        "tags": [],
+        "label": "SubFeature",
+        "description": [],
+        "signature": [
+          "\"endpointSecurity\""
+        ],
+        "path": "x-pack/platform/plugins/shared/actions/common/types.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "actions",
         "id": "def-common.UptimeConnectorFeatureId",
@@ -6288,6 +6388,53 @@
         ],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "actions",
+        "id": "def-common.EndpointSecurityConnectorFeature",
+        "type": "Object",
+        "tags": [],
+        "label": "EndpointSecurityConnectorFeature",
+        "description": [],
+        "path": "x-pack/platform/plugins/shared/actions/common/connector_feature_config.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "children": [
+          {
+            "parentPluginId": "actions",
+            "id": "def-common.EndpointSecurityConnectorFeature.id",
+            "type": "string",
+            "tags": [],
+            "label": "id",
+            "description": [],
+            "path": "x-pack/platform/plugins/shared/actions/common/connector_feature_config.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          },
+          {
+            "parentPluginId": "actions",
+            "id": "def-common.EndpointSecurityConnectorFeature.name",
+            "type": "string",
+            "tags": [],
+            "label": "name",
+            "description": [],
+            "path": "x-pack/platform/plugins/shared/actions/common/connector_feature_config.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          },
+          {
+            "parentPluginId": "actions",
+            "id": "def-common.EndpointSecurityConnectorFeature.compatibility",
+            "type": "string",
+            "tags": [],
+            "label": "compatibility",
+            "description": [],
+            "path": "x-pack/platform/plugins/shared/actions/common/connector_feature_config.ts",
+            "deprecated": false,
+            "trackAdoption": false
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "actions",
         "id": "def-common.executionLogSortableColumns",

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: 2025-01-06
+date: 2025-01-07
 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 |
 |-------------------|-----------|------------------------|-----------------|
-| 321 | 0 | 315 | 37 |
+| 331 | 0 | 325 | 37 |
 
 ## Client
 
@@ -48,6 +48,9 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
 ### Interfaces
 <DocDefinitionList data={actionsObj.server.interfaces}/>
 
+### Enums
+<DocDefinitionList data={actionsObj.server.enums}/>
+
 ### Consts, variables and types
 <DocDefinitionList data={actionsObj.server.misc}/>
 

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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
 ---
 import apmDataAccessObj from './apm_data_access.devdocs.json';

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: 2025-01-06
+date: 2025-01-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetInventory']
 ---
 import assetInventoryObj from './asset_inventory.devdocs.json';

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: 2025-01-06
+date: 2025-01-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 ---
 import bannersObj from './banners.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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 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: 2025-01-06
+date: 2025-01-07
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
 ---
 import contentManagementObj from './content_management.devdocs.json';

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