[api-docs] 2023-02-28 Daily api_docs build (elastic#152312)

Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/262
ashokaditya · Feb 28, 2023 · a9bcdaf · a9bcdaf
1 parent 4aa0961
commit a9bcdaf
Show file tree

Hide file tree

Showing 507 changed files with 3,736 additions and 1,377 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: 2023-02-27
+date: 2023-02-28
 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: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
 ---
 import advancedSettingsObj from './advanced_settings.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: 2023-02-27
+date: 2023-02-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
@@ -867,6 +867,69 @@
       }
     ],
     "functions": [
+      {
+        "parentPluginId": "alerting",
+        "id": "def-server.getComponentTemplate",
+        "type": "Function",
+        "tags": [],
+        "label": "getComponentTemplate",
+        "description": [],
+        "signature": [
+          "(fieldMap: ",
+          {
+            "pluginId": "@kbn/alerts-as-data-utils",
+            "scope": "common",
+            "docId": "kibKbnAlertsAsDataUtilsPluginApi",
+            "section": "def-common.FieldMap",
+            "text": "FieldMap"
+          },
+          ", context?: string | undefined) => ",
+          "ClusterPutComponentTemplateRequest"
+        ],
+        "path": "x-pack/plugins/alerting/server/alerts_service/types.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-server.getComponentTemplate.$1",
+            "type": "Object",
+            "tags": [],
+            "label": "fieldMap",
+            "description": [],
+            "signature": [
+              {
+                "pluginId": "@kbn/alerts-as-data-utils",
+                "scope": "common",
+                "docId": "kibKbnAlertsAsDataUtilsPluginApi",
+                "section": "def-common.FieldMap",
+                "text": "FieldMap"
+              }
+            ],
+            "path": "x-pack/plugins/alerting/server/alerts_service/types.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "isRequired": true
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-server.getComponentTemplate.$2",
+            "type": "string",
+            "tags": [],
+            "label": "context",
+            "description": [],
+            "signature": [
+              "string | undefined"
+            ],
+            "path": "x-pack/plugins/alerting/server/alerts_service/types.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "isRequired": false
+          }
+        ],
+        "returnComment": [],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-server.getEsErrorMessage",
@@ -3239,6 +3302,33 @@
         "trackAdoption": false,
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-server.ECS_COMPONENT_TEMPLATE_NAME",
+        "type": "string",
+        "tags": [],
+        "label": "ECS_COMPONENT_TEMPLATE_NAME",
+        "description": [],
+        "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-server.ECS_CONTEXT",
+        "type": "string",
+        "tags": [],
+        "label": "ECS_CONTEXT",
+        "description": [],
+        "signature": [
+          "\"ecs\""
+        ],
+        "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-server.ExecutorType",
@@ -3938,6 +4028,42 @@
         "returnComment": [],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-common.getComponentTemplateFromFieldMap",
+        "type": "Function",
+        "tags": [],
+        "label": "getComponentTemplateFromFieldMap",
+        "description": [],
+        "signature": [
+          "({ name, fieldMap, fieldLimit, }: ",
+          "GetComponentTemplateFromFieldMapOpts",
+          ") => ",
+          "ClusterPutComponentTemplateRequest"
+        ],
+        "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.getComponentTemplateFromFieldMap.$1",
+            "type": "Object",
+            "tags": [],
+            "label": "{\n  name,\n  fieldMap,\n  fieldLimit,\n}",
+            "description": [],
+            "signature": [
+              "GetComponentTemplateFromFieldMapOpts"
+            ],
+            "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "isRequired": true
+          }
+        ],
+        "returnComment": [],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-common.getDurationNumberInItsUnit",
@@ -4052,6 +4178,69 @@
         "returnComment": [],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-common.mappingFromFieldMap",
+        "type": "Function",
+        "tags": [],
+        "label": "mappingFromFieldMap",
+        "description": [],
+        "signature": [
+          "(fieldMap: ",
+          {
+            "pluginId": "@kbn/alerts-as-data-utils",
+            "scope": "common",
+            "docId": "kibKbnAlertsAsDataUtilsPluginApi",
+            "section": "def-common.FieldMap",
+            "text": "FieldMap"
+          },
+          ", dynamic: boolean | \"strict\") => ",
+          "MappingTypeMapping"
+        ],
+        "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.mappingFromFieldMap.$1",
+            "type": "Object",
+            "tags": [],
+            "label": "fieldMap",
+            "description": [],
+            "signature": [
+              {
+                "pluginId": "@kbn/alerts-as-data-utils",
+                "scope": "common",
+                "docId": "kibKbnAlertsAsDataUtilsPluginApi",
+                "section": "def-common.FieldMap",
+                "text": "FieldMap"
+              }
+            ],
+            "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "isRequired": true
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.mappingFromFieldMap.$2",
+            "type": "CompoundType",
+            "tags": [],
+            "label": "dynamic",
+            "description": [],
+            "signature": [
+              "boolean | \"strict\""
+            ],
+            "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
+            "deprecated": false,
+            "trackAdoption": false,
+            "isRequired": true
+          }
+        ],
+        "returnComment": [],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-common.parseDuration",

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: 2023-02-27
+date: 2023-02-28
 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 |
 |-------------------|-----------|------------------------|-----------------|
-| 487 | 1 | 476 | 40 |
+| 497 | 1 | 486 | 41 |
 
 ## 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: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 ---
 import apmObj from './apm.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: 2023-02-27
+date: 2023-02-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: 2023-02-27
+date: 2023-02-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: 2023-02-27
+date: 2023-02-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: 2023-02-27
+date: 2023-02-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: 2023-02-27
+date: 2023-02-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: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
 ---
 import cloudObj from './cloud.devdocs.json';

diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
 title: "cloudChat"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloudChat plugin
-date: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
 ---
 import cloudChatObj from './cloud_chat.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: 2023-02-27
+date: 2023-02-28
 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: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
 ---
 import cloudDefendObj from './cloud_defend.devdocs.json';

diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
 title: "cloudExperiments"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloudExperiments plugin
-date: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
 ---
 import cloudExperimentsObj from './cloud_experiments.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: 2023-02-27
+date: 2023-02-28
 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: 2023-02-27
+date: 2023-02-28
 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: 2023-02-27
+date: 2023-02-28
 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: 2023-02-27
+date: 2023-02-28
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
 ---
 import controlsObj from './controls.devdocs.json';