mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 03:01:21 -04:00
[api-docs] 2023-12-05 Daily api_docs build (#172537)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/542
This commit is contained in:
Kibana Machine
GitHub
parent
7508ee1ed5
commit
4a47b5b452
667 changed files with 4677 additions and 1720 deletions
|
|
@ -5170,15 +5170,15 @@
|
|||
"signature": [
|
||||
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: K extends \"frequency\" ? ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T[K]> : T[K]; }"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -5283,15 +5283,15 @@
|
|||
"signature": [
|
||||
"(requested: ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T>) => T"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"returnComment": [],
|
||||
|
|
@ -5306,15 +5306,15 @@
|
|||
"signature": [
|
||||
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: K extends \"frequency\" ? ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T[K]> : T[K]; }"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
@ -5331,23 +5331,23 @@
|
|||
"signature": [
|
||||
"(responded: T) => T extends (infer Item)[] ? ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<Item>[] : ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T>"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"returnComment": [],
|
||||
|
|
@ -5362,7 +5362,7 @@
|
|||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
---
|
||||
import actionsObj from './actions.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -124,6 +124,10 @@
|
|||
"plugin": "stackAlerts",
|
||||
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "stackAlerts",
|
||||
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "stackAlerts",
|
||||
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
||||
|
|
@ -1450,15 +1454,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds>"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
|
@ -1472,7 +1476,7 @@
|
|||
"signature": [
|
||||
"ActionGroupIds"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -1483,7 +1487,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
@ -4058,9 +4062,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
|
|
@ -4093,9 +4097,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
|
|
@ -4191,25 +4195,25 @@
|
|||
"signature": [
|
||||
"{ context?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[] | undefined; state?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[] | undefined; params?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
|
|
@ -4513,23 +4517,23 @@
|
|||
"signature": [
|
||||
"T extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups> ? groups : T extends Readonly<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups>> ? groups : never"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -5110,6 +5114,21 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.ScopedQueryAlerts",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ScopedQueryAlerts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: string[]; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.TOTAL_FIELDS_LIMIT",
|
||||
|
|
@ -5452,17 +5471,17 @@
|
|||
"signature": [
|
||||
"(customRecoveryGroup: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<RecoveryActionGroupId> | undefined) => [",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
|
|
@ -5489,9 +5508,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
|
|
@ -5738,6 +5757,39 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.getScopedQueryErrorMessage",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getScopedQueryErrorMessage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(errorMessage: string) => string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.getScopedQueryErrorMessage.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "errorMessage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.isActionGroupDisabledForActionTypeId",
|
||||
|
|
@ -5786,6 +5838,39 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.isScopedQueryError",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isScopedQueryError",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(errorMessage: string) => boolean"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.isScopedQueryError.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "errorMessage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.mappingFromFieldMap",
|
||||
|
|
@ -5992,15 +6077,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds>"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
|
@ -6014,7 +6099,7 @@
|
|||
"signature": [
|
||||
"ActionGroupIds"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -6025,7 +6110,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
@ -6039,7 +6124,7 @@
|
|||
"tags": [],
|
||||
"label": "ActionVariable",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
|
@ -6050,7 +6135,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -6061,7 +6146,7 @@
|
|||
"tags": [],
|
||||
"label": "description",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -6075,7 +6160,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -6089,7 +6174,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -6103,7 +6188,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
@ -7583,7 +7668,13 @@
|
|||
"label": "scopedQuery",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ScopedQueryAttributes",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ScopedQueryAttributes",
|
||||
"text": "ScopedQueryAttributes"
|
||||
},
|
||||
" | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
|
|
@ -9329,15 +9420,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.RuleType",
|
||||
"text": "RuleType"
|
||||
},
|
||||
"<ActionGroupIds, RecoveryActionGroupId>"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
|
@ -9348,7 +9439,7 @@
|
|||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9359,7 +9450,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9372,15 +9463,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds>[]"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9393,15 +9484,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<RecoveryActionGroupId>"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9413,9 +9504,33 @@
|
|||
"label": "actionVariables",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ context: ActionVariable[]; state: ActionVariable[]; params: ActionVariable[]; }"
|
||||
"{ context: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; state: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; params: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9429,7 +9544,7 @@
|
|||
"signature": [
|
||||
"ActionGroupIds"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9440,7 +9555,7 @@
|
|||
"tags": [],
|
||||
"label": "category",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9451,7 +9566,7 @@
|
|||
"tags": [],
|
||||
"label": "producer",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9465,7 +9580,7 @@
|
|||
"signature": [
|
||||
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9476,7 +9591,7 @@
|
|||
"tags": [],
|
||||
"label": "isExportable",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9490,7 +9605,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9504,7 +9619,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9518,7 +9633,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9529,7 +9644,7 @@
|
|||
"tags": [],
|
||||
"label": "enabledInLicense",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
|
@ -9543,7 +9658,7 @@
|
|||
"signature": [
|
||||
"{ [x: string]: ConsumerPrivileges; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
@ -9623,6 +9738,60 @@
|
|||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.ScopedQueryAttributes",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ScopedQueryAttributes",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.ScopedQueryAttributes.kql",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "kql",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.ScopedQueryAttributes.filters",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ScopeQueryFilter",
|
||||
"[]"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.ScopedQueryAttributes.dsl",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "dsl",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [
|
||||
|
|
@ -9728,23 +9897,23 @@
|
|||
"signature": [
|
||||
"T extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups> ? groups : T extends Readonly<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups>> ? groups : never"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule_type.ts",
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -9924,7 +10093,7 @@
|
|||
"signature": [
|
||||
"\"default\""
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -10394,7 +10563,13 @@
|
|||
"text": "RRuleParams"
|
||||
},
|
||||
"; categoryIds?: string[] | null | undefined; scopedQuery?: ",
|
||||
"ScopedQueryAttributes",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ScopedQueryAttributes",
|
||||
"text": "ScopedQueryAttributes"
|
||||
},
|
||||
" | null | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
||||
|
|
@ -10638,7 +10813,7 @@
|
|||
"signature": [
|
||||
"\"recovered\""
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -13702,7 +13877,7 @@
|
|||
"signature": [
|
||||
"{ readonly id: \"recovered\"; readonly name: string; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 813 | 1 | 782 | 51 |
|
||||
| 822 | 1 | 791 | 51 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
|
||||
---
|
||||
import apmDataAccessObj from './apm_data_access.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
|
|||
title: "assetManager"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the assetManager plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
|
||||
---
|
||||
import assetManagerObj from './asset_manager.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
---
|
||||
import bannersObj from './banners.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
---
|
||||
import bfetchObj from './bfetch.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -230,7 +230,13 @@
|
|||
"; basePath?: string | undefined; releasePhase?: ",
|
||||
"ReleasePhase",
|
||||
" | undefined; hiddenStatuses?: ",
|
||||
"CaseStatusWithAllStatus",
|
||||
{
|
||||
"pluginId": "@kbn/cases-components",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCasesComponentsPluginApi",
|
||||
"section": "def-common.CaseStatuses",
|
||||
"text": "CaseStatuses"
|
||||
},
|
||||
"[] | undefined; onRowClick?: ((theCase?: ",
|
||||
{
|
||||
"pluginId": "cases",
|
||||
|
|
@ -482,7 +488,15 @@
|
|||
"section": "def-common.CaseStatuses",
|
||||
"text": "CaseStatuses"
|
||||
},
|
||||
" | undefined; severity?: ",
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "@kbn/cases-components",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCasesComponentsPluginApi",
|
||||
"section": "def-common.CaseStatuses",
|
||||
"text": "CaseStatuses"
|
||||
},
|
||||
"[] | undefined; severity?: ",
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
|
|
@ -490,7 +504,15 @@
|
|||
"section": "def-common.CaseSeverity",
|
||||
"text": "CaseSeverity"
|
||||
},
|
||||
" | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; from?: string | undefined; search?: string | undefined; searchFields?: \"description\" | \"title\" | (\"description\" | \"title\")[] | undefined; sortField?: \"category\" | \"title\" | \"createdAt\" | \"updatedAt\" | \"status\" | \"severity\" | \"closedAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; category?: string | string[] | undefined; } & Partial<",
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.CaseSeverity",
|
||||
"text": "CaseSeverity"
|
||||
},
|
||||
"[] | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; from?: string | undefined; search?: string | undefined; searchFields?: \"description\" | \"title\" | (\"description\" | \"title\")[] | undefined; sortField?: \"category\" | \"title\" | \"createdAt\" | \"updatedAt\" | \"status\" | \"severity\" | \"closedAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; category?: string | string[] | undefined; } & Partial<",
|
||||
"Pagination",
|
||||
">, signal?: AbortSignal | undefined) => Promise<",
|
||||
{
|
||||
|
|
@ -3157,21 +3179,6 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.StatusAll",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "StatusAll",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"all\""
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.UPDATE_CASES_CAPABILITY",
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 115 | 0 | 95 | 28 |
|
||||
| 114 | 0 | 94 | 27 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
---
|
||||
import chartsObj from './charts.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
|
||||
---
|
||||
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
|
||||
---
|
||||
import cloudDefendObj from './cloud_defend.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
|
||||
---
|
||||
import cloudExperimentsObj from './cloud_experiments.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
---
|
||||
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
|
||||
---
|
||||
import contentManagementObj from './content_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
|
|||
title: "customIntegrations"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the customIntegrations plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
---
|
||||
import customIntegrationsObj from './custom_integrations.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
|
|||
title: "dashboard"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dashboard plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
---
|
||||
import dashboardObj from './dashboard.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
|
|||
title: "dashboardEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dashboardEnhanced plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
|
|||
title: "data"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
|
|||
title: "data.query"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data.query plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
|
|||
title: "data.search"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data.search plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
|
|||
title: "dataViewEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewEditor plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
---
|
||||
import dataViewEditorObj from './data_view_editor.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
|
|||
title: "dataViewFieldEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewFieldEditor plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
---
|
||||
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
|
|||
title: "dataViewManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewManagement plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
|
|||
title: "dataViews"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViews plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
---
|
||||
import dataViewsObj from './data_views.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
|
|||
title: "dataVisualizer"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataVisualizer plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
|
|||
title: "datasetQuality"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the datasetQuality plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
|
||||
---
|
||||
import datasetQualityObj from './dataset_quality.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
|
||||
title: Deprecated API usage by API
|
||||
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
@ -127,7 +127,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibKbnReportingExportTypesPdfPluginApi" section="def-server.PdfV1ExportType" text="PdfV1ExportType"/> | reporting | - |
|
||||
| <DocLink id="kibKbnReportingExportTypesPdfCommonPluginApi" section="def-common.JobParamsPDFDeprecated" text="JobParamsPDFDeprecated"/> | @kbn/reporting-export-types-pdf, reporting | - |
|
||||
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-common.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal, observabilityOnboarding, console | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-common.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | @kbn/content-management-table-list-view, filesManagement | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-public.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | @kbn/content-management-table-list-view, filesManagement | - |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - |
|
||||
| <DocLink id="kibKibanaReactPluginApi" section="def-common.KibanaStyledComponentsThemeProviderDecorator" text="KibanaStyledComponentsThemeProviderDecorator"/> | @kbn/react-kibana-context-styled, kibanaReact | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | encryptedSavedObjects | - |
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
|
||||
title: Deprecated API usage by plugin
|
||||
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-common.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | [table_list_view.tsx](https://github.com/elastic/kibana/tree/main/packages/content-management/table_list_view/src/table_list_view.tsx#:~:text=withoutPageTemplateWrapper), [table_list_view.tsx](https://github.com/elastic/kibana/tree/main/packages/content-management/table_list_view/src/table_list_view.tsx#:~:text=withoutPageTemplateWrapper) | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-public.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | [table_list_view.tsx](https://github.com/elastic/kibana/tree/main/packages/content-management/table_list_view/src/table_list_view.tsx#:~:text=withoutPageTemplateWrapper), [table_list_view.tsx](https://github.com/elastic/kibana/tree/main/packages/content-management/table_list_view/src/table_list_view.tsx#:~:text=withoutPageTemplateWrapper) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -815,7 +815,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=toMountPoint), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=toMountPoint) | - |
|
||||
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider), [mount_management_section.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/mount_management_section.tsx#:~:text=KibanaThemeProvider) | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-common.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/app.tsx#:~:text=withoutPageTemplateWrapper) | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-public.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/files_management/public/app.tsx#:~:text=withoutPageTemplateWrapper) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -1360,7 +1360,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider) | - |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24) | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |
|
||||
| <DocLink id="kibTimelinesPluginApi" section="def-common.DeprecatedCellValueElementProps" text="DeprecatedCellValueElementProps"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps) | - |
|
||||
| <DocLink id="kibTimelinesPluginApi" section="def-common.DeprecatedRowRenderer" text="DeprecatedRowRenderer"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer) | - |
|
||||
|
|
@ -1429,7 +1429,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation) | - |
|
||||
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation) | - |
|
||||
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | [rule_type.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts#:~:text=alertFactory), [get_entities_and_generate_alerts.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/data_view_select.tsx#:~:text=indexPatterns), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=indexPatterns), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=indexPatterns), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=indexPatterns), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=indexPatterns) | - |
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
|
|||
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
|
||||
title: Deprecated APIs due to be removed, by team
|
||||
description: Lists the teams that are referencing deprecated APIs with a remove by date.
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
@ -165,4 +165,4 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
| --------|-------|-----------|-----------|
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24) | 8.8.0 |
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |
|
||||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
|
|||
title: "devTools"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the devTools plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
|
|||
title: "discover"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discover plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
|
|||
title: "discoverEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discoverEnhanced plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
|
|||
title: "ecsDataQualityDashboard"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the ecsDataQualityDashboard plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
|
||||
---
|
||||
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
|
|||
title: "elasticAssistant"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the elasticAssistant plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
|
||||
---
|
||||
import elasticAssistantObj from './elastic_assistant.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
|
|||
title: "embeddable"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the embeddable plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
---
|
||||
import embeddableObj from './embeddable.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
|
|||
title: "embeddableEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the embeddableEnhanced plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
---
|
||||
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
|
|||
title: "encryptedSavedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the encryptedSavedObjects plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
|
|||
title: "enterpriseSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the enterpriseSearch plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
|
|||
title: "esUiShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esUiShared plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
|
|||
title: "eventAnnotation"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotation plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
|
|||
title: "eventAnnotationListing"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotationListing plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
|
||||
---
|
||||
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
|
|||
title: "eventLog"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventLog plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
|
|||
title: "exploratoryView"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the exploratoryView plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
|
||||
---
|
||||
import exploratoryViewObj from './exploratory_view.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
|
|||
title: "expressionError"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionError plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
---
|
||||
import expressionErrorObj from './expression_error.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
|
|||
title: "expressionGauge"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionGauge plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
---
|
||||
import expressionGaugeObj from './expression_gauge.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
|
|||
title: "expressionHeatmap"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionHeatmap plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
---
|
||||
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
|
|||
title: "expressionImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionImage plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
---
|
||||
import expressionImageObj from './expression_image.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
|
|||
title: "expressionLegacyMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionLegacyMetricVis plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
---
|
||||
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
|
|||
title: "expressionMetric"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionMetric plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
---
|
||||
import expressionMetricObj from './expression_metric.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
|
|||
title: "expressionMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionMetricVis plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
|
|||
title: "expressionPartitionVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionPartitionVis plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
---
|
||||
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
|
|||
title: "expressionRepeatImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionRepeatImage plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
---
|
||||
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
|
|||
title: "expressionRevealImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionRevealImage plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
---
|
||||
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
|
|||
title: "expressionShape"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionShape plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
---
|
||||
import expressionShapeObj from './expression_shape.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
|
|||
title: "expressionTagcloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionTagcloud plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
---
|
||||
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
|
|||
title: "expressionXY"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionXY plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
|
|||
title: "expressions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressions plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
|
|||
title: "features"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the features plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
---
|
||||
import featuresObj from './features.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
|
|||
title: "fieldFormats"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fieldFormats plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
|
|||
title: "fileUpload"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fileUpload plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
|
|||
title: "files"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the files plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
|
|||
title: "filesManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the filesManagement plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
|
||||
---
|
||||
import filesManagementObj from './files_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
|
|||
title: "fleet"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fleet plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
---
|
||||
import fleetObj from './fleet.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
|
|||
title: "globalSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the globalSearch plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
|
|||
title: "guidedOnboarding"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the guidedOnboarding plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
|
|||
title: "home"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the home plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
|
|||
title: "imageEmbeddable"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the imageEmbeddable plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
|
||||
---
|
||||
import imageEmbeddableObj from './image_embeddable.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
|
|||
title: "indexLifecycleManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the indexLifecycleManagement plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
---
|
||||
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
|
|||
title: "indexManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the indexManagement plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
|
|||
title: "infra"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the infra plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
---
|
||||
import infraObj from './infra.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
|
|||
title: "inspector"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the inspector plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
---
|
||||
import inspectorObj from './inspector.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
|
|||
title: "interactiveSetup"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the interactiveSetup plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
---
|
||||
import interactiveSetupObj from './interactive_setup.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
|
|||
title: "@kbn/ace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ace plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
---
|
||||
import kbnAceObj from './kbn_ace.devdocs.json';
|
||||
|
|
|
|||
147
api_docs/kbn_actions_types.devdocs.json
Normal file
147
api_docs/kbn_actions_types.devdocs.json
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
{
|
||||
"id": "@kbn/actions-types",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/actions-types",
|
||||
"id": "def-common.AsApiContract",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "AsApiContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: K extends \"frequency\" ? ",
|
||||
{
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T[K]> : T[K]; }"
|
||||
],
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/actions-types",
|
||||
"id": "def-common.RewriteRequestCase",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "RewriteRequestCase",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(requested: ",
|
||||
{
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T>) => T"
|
||||
],
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/actions-types",
|
||||
"id": "def-common.RewriteRequestCase.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "requested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: K extends \"frequency\" ? ",
|
||||
{
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T[K]> : T[K]; }"
|
||||
],
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/actions-types",
|
||||
"id": "def-common.RewriteResponseCase",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "RewriteResponseCase",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(responded: T) => T extends (infer Item)[] ? ",
|
||||
{
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<Item>[] : ",
|
||||
{
|
||||
"pluginId": "@kbn/actions-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnActionsTypesPluginApi",
|
||||
"section": "def-common.AsApiContract",
|
||||
"text": "AsApiContract"
|
||||
},
|
||||
"<T>"
|
||||
],
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/actions-types",
|
||||
"id": "def-common.RewriteResponseCase.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "responded",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "packages/kbn-actions-types/rewrite_request_case_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
30
api_docs/kbn_actions_types.mdx
Normal file
30
api_docs/kbn_actions_types.mdx
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
####
|
||||
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
#### Reach out in #docs-engineering for more info.
|
||||
####
|
||||
id: kibKbnActionsTypesPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-actions-types
|
||||
title: "@kbn/actions-types"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/actions-types plugin
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
|
||||
---
|
||||
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 5 | 0 | 5 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={kbnActionsTypesObj.common.misc}/>
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
|
|||
title: "@kbn/aiops-components"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/aiops-components plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
|
||||
---
|
||||
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
|
|||
title: "@kbn/aiops-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/aiops-utils plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
|
||||
---
|
||||
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-api-integration-helpers
|
|||
title: "@kbn/alerting-api-integration-helpers"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerting-api-integration-helpers plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
|
||||
---
|
||||
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
|
|||
title: "@kbn/alerting-state-types"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerting-state-types plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
|
||||
---
|
||||
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';
|
||||
|
|
|
|||
487
api_docs/kbn_alerting_types.devdocs.json
Normal file
487
api_docs/kbn_alerting_types.devdocs.json
Normal file
|
|
@ -0,0 +1,487 @@
|
|||
{
|
||||
"id": "@kbn/alerting-types",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroup",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ActionGroup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds>"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroup.id",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ActionGroupIds"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroup.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ActionVariable",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable.description",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "description",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable.deprecated",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "deprecated",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable.useWithTripleBracesInTemplates",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "useWithTripleBracesInTemplates",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionVariable.usesPublicBaseUrl",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "usesPublicBaseUrl",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.RuleType",
|
||||
"text": "RuleType"
|
||||
},
|
||||
"<ActionGroupIds, RecoveryActionGroupId>"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.actionGroups",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "actionGroups",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds>[]"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.recoveryActionGroup",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "recoveryActionGroup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<RecoveryActionGroupId>"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.actionVariables",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "actionVariables",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ context: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; state: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; params: ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionVariable",
|
||||
"text": "ActionVariable"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.defaultActionGroupId",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "defaultActionGroupId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ActionGroupIds"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.category",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "category",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.producer",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "producer",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.minimumLicenseRequired",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "minimumLicenseRequired",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.isExportable",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isExportable",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.ruleTaskTimeout",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ruleTaskTimeout",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.defaultScheduleInterval",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "defaultScheduleInterval",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.doesSetRecoveryContext",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "doesSetRecoveryContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.enabledInLicense",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "enabledInLicense",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RuleType.authorizedConsumers",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "authorizedConsumers",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: ConsumerPrivileges; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroupIdsOf",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ActionGroupIdsOf",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T extends ",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups> ? groups : T extends Readonly<",
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups>> ? groups : never"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.DefaultActionGroupId",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "DefaultActionGroupId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"default\""
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RecoveredActionGroupId",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "RecoveredActionGroupId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"recovered\""
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.RecoveredActionGroup",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "RecoveredActionGroup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly id: \"recovered\"; readonly name: string; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
36
api_docs/kbn_alerting_types.mdx
Normal file
36
api_docs/kbn_alerting_types.mdx
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
####
|
||||
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
#### Reach out in #docs-engineering for more info.
|
||||
####
|
||||
id: kibKbnAlertingTypesPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-alerting-types
|
||||
title: "@kbn/alerting-types"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerting-types plugin
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-types']
|
||||
---
|
||||
import kbnAlertingTypesObj from './kbn_alerting_types.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 29 | 0 | 29 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={kbnAlertingTypesObj.common.objects}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={kbnAlertingTypesObj.common.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={kbnAlertingTypesObj.common.misc}/>
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
|
|||
title: "@kbn/alerts-as-data-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts-as-data-utils plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
|
||||
---
|
||||
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
|
|||
title: "@kbn/alerts-ui-shared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts-ui-shared plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
|
||||
---
|
||||
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 11 | 0 | 10 | 1 |
|
||||
| 83 | 0 | 82 | 1 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
|
|||
title: "@kbn/analytics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
|
||||
---
|
||||
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
|
|||
title: "@kbn/analytics-client"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-client plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
|
||||
---
|
||||
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-collection-utils
|
|||
title: "@kbn/analytics-collection-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-collection-utils plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-collection-utils']
|
||||
---
|
||||
import kbnAnalyticsCollectionUtilsObj from './kbn_analytics_collection_utils.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser
|
|||
title: "@kbn/analytics-shippers-elastic-v3-browser"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common
|
|||
title: "@kbn/analytics-shippers-elastic-v3-common"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server
|
|||
title: "@kbn/analytics-shippers-elastic-v3-server"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
|
|||
title: "@kbn/analytics-shippers-fullstory"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-fullstory plugin
|
||||
date: 2023-12-04
|
||||
date: 2023-12-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
|
||||
---
|
||||
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue