[api-docs] 2024-08-28 Daily api_docs build (#191567)

Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/813
elastic · Aug 28, 2024 · 094f4a3 · 094f4a3
1 parent a994629
commit 094f4a3
Show file tree

Hide file tree

Showing 756 changed files with 4,955 additions and 919 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
@@ -317,7 +317,9 @@
             "label": "addComment",
             "description": [],
             "signature": [
-              "({ incidentId, comment, }: { incidentId: string; comment: string; }) => Promise<void>"
+              "({ incidentId, comment, }: { incidentId: string; comment: string; }, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<void>"
             ],
             "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
             "deprecated": false,
@@ -328,7 +330,7 @@
                 "id": "def-server.CaseConnector.addComment.$1",
                 "type": "Object",
                 "tags": [],
-                "label": "{\n    incidentId,\n    comment,\n  }",
+                "label": "{\n      incidentId,\n      comment,\n    }",
                 "description": [],
                 "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
                 "deprecated": false,
@@ -357,6 +359,21 @@
                     "trackAdoption": false
                   }
                 ]
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.CaseConnector.addComment.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -369,7 +386,9 @@
             "label": "createIncident",
             "description": [],
             "signature": [
-              "(incident: Incident) => Promise<",
+              "(incident: Incident, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<",
               "ExternalServiceIncidentResponse",
               ">"
             ],
@@ -391,6 +410,21 @@
                 "deprecated": false,
                 "trackAdoption": false,
                 "isRequired": true
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.CaseConnector.createIncident.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -403,7 +437,9 @@
             "label": "updateIncident",
             "description": [],
             "signature": [
-              "({ incidentId, incident, }: { incidentId: string; incident: Incident; }) => Promise<",
+              "({ incidentId, incident, }: { incidentId: string; incident: Incident; }, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<",
               "ExternalServiceIncidentResponse",
               ">"
             ],
@@ -416,7 +452,7 @@
                 "id": "def-server.CaseConnector.updateIncident.$1",
                 "type": "Object",
                 "tags": [],
-                "label": "{\n    incidentId,\n    incident,\n  }",
+                "label": "{\n      incidentId,\n      incident,\n    }",
                 "description": [],
                 "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
                 "deprecated": false,
@@ -448,6 +484,21 @@
                     "trackAdoption": false
                   }
                 ]
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.CaseConnector.updateIncident.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -460,7 +511,9 @@
             "label": "getIncident",
             "description": [],
             "signature": [
-              "({ id }: { id: string; }) => Promise<GetIncidentResponse>"
+              "({ id }: { id: string; }, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<GetIncidentResponse>"
             ],
             "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
             "deprecated": false,
@@ -489,6 +542,21 @@
                     "trackAdoption": false
                   }
                 ]
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.CaseConnector.getIncident.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -501,7 +569,9 @@
             "label": "pushToService",
             "description": [],
             "signature": [
-              "(params: { incident: { externalId: string | null; } & Incident; comments: { commentId: string; comment: string; }[]; }) => Promise<",
+              "(params: { incident: { externalId: string | null; } & Incident; comments: { commentId: string; comment: string; }[]; }, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<",
               "PushToServiceResponse",
               ">"
             ],
@@ -549,6 +619,21 @@
                     "trackAdoption": false
                   }
                 ]
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.CaseConnector.pushToService.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -2116,7 +2201,9 @@
             "signature": [
               "<R>({ url, data, method, responseSchema, headers, timeout, ...config }: ",
               "SubActionRequestParams",
-              "<R>) => Promise<",
+              "<R>, connectorUsageCollector: ",
+              "ConnectorUsageCollector",
+              ") => Promise<",
               "AxiosResponse",
               "<R, any>>"
             ],
@@ -2129,7 +2216,7 @@
                 "id": "def-server.SubActionConnector.request.$1",
                 "type": "CompoundType",
                 "tags": [],
-                "label": "{\n    url,\n    data,\n    method = 'get',\n    responseSchema,\n    headers,\n    timeout,\n    ...config\n  }",
+                "label": "{\n      url,\n      data,\n      method = 'get',\n      responseSchema,\n      headers,\n      timeout,\n      ...config\n    }",
                 "description": [],
                 "signature": [
                   "SubActionRequestParams",
@@ -2139,6 +2226,21 @@
                 "deprecated": false,
                 "trackAdoption": false,
                 "isRequired": true
+              },
+              {
+                "parentPluginId": "actions",
+                "id": "def-server.SubActionConnector.request.$2",
+                "type": "Object",
+                "tags": [],
+                "label": "connectorUsageCollector",
+                "description": [],
+                "signature": [
+                  "ConnectorUsageCollector"
+                ],
+                "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
+                "deprecated": false,
+                "trackAdoption": false,
+                "isRequired": true
               }
             ],
             "returnComment": []
@@ -3141,6 +3243,20 @@
             "path": "x-pack/plugins/actions/server/types.ts",
             "deprecated": false,
             "trackAdoption": false
+          },
+          {
+            "parentPluginId": "actions",
+            "id": "def-server.ActionTypeExecutorOptions.connectorUsageCollector",
+            "type": "Object",
+            "tags": [],
+            "label": "connectorUsageCollector",
+            "description": [],
+            "signature": [
+              "ConnectorUsageCollector"
+            ],
+            "path": "x-pack/plugins/actions/server/types.ts",
+            "deprecated": false,
+            "trackAdoption": false
           }
         ],
         "initialIsOpen": false

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-08-27
+date: 2024-08-28
 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 |
 |-------------------|-----------|------------------------|-----------------|
-| 307 | 0 | 301 | 32 |
+| 314 | 0 | 308 | 33 |
 
 ## 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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
@@ -3806,14 +3806,6 @@
                 "plugin": "securitySolution",
                 "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts"
               },
-              {
-                "plugin": "synthetics",
-                "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts"
-              },
-              {
-                "plugin": "synthetics",
-                "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/tls_rule.ts"
-              },
               {
                 "plugin": "ruleRegistry",
                 "path": "x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts"

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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
 ---
 import apmDataAccessObj from './apm_data_access.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: 2024-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 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-08-27
+date: 2024-08-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
 ---
 import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';