mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[api-docs] 2022-11-15 Daily api_docs build (#145203)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/157
This commit is contained in:
parent
c4304dc9a2
commit
add9ad0bf6
462 changed files with 1875 additions and 945 deletions
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
@ -98,7 +98,15 @@
|
|||
"section": "def-common.RuleSnooze",
|
||||
"text": "RuleSnooze"
|
||||
},
|
||||
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; }"
|
||||
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; lastRun?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleLastRun",
|
||||
"text": "RuleLastRun"
|
||||
},
|
||||
" | null | undefined; nextRun?: Date | null | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -2184,6 +2192,21 @@
|
|||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.RuleExecutorServices.ruleMonitoringService",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "ruleMonitoringService",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"PublicRuleMonitoringService",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -5149,6 +5172,41 @@
|
|||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.Rule.lastRun",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "lastRun",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleLastRun",
|
||||
"text": "RuleLastRun"
|
||||
},
|
||||
" | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.Rule.nextRun",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "nextRun",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Date | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -5245,6 +5303,20 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleAggregations.ruleLastRunOutcome",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "ruleLastRunOutcome",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [status: string]: number; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleAggregations.ruleEnabledStatus",
|
||||
|
@ -5404,6 +5476,91 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRun",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleLastRun",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRun.outcome",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "outcome",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"warning\" | \"succeeded\" | \"failed\""
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRun.warning",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "warning",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleExecutionStatusErrorReasons",
|
||||
"text": "RuleExecutionStatusErrorReasons"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleExecutionStatusWarningReasons",
|
||||
"text": "RuleExecutionStatusWarningReasons"
|
||||
},
|
||||
" | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRun.outcomeMsg",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "outcomeMsg",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRun.alertsCount",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "alertsCount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ active?: number | null | undefined; new?: number | null | undefined; recovered?: number | null | undefined; ignored?: number | null | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoring",
|
||||
|
@ -5411,13 +5568,65 @@
|
|||
"tags": [],
|
||||
"label": "RuleMonitoring",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoring.run",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "run",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ history: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringHistory",
|
||||
"text": "RuleMonitoringHistory"
|
||||
},
|
||||
"[]; calculated_metrics: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringCalculatedMetrics",
|
||||
"text": "RuleMonitoringCalculatedMetrics"
|
||||
},
|
||||
"; last_run: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringLastRun",
|
||||
"text": "RuleMonitoringLastRun"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringCalculatedMetrics",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleMonitoringCalculatedMetrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoring",
|
||||
"text": "RuleMonitoring"
|
||||
"section": "def-common.RuleMonitoringCalculatedMetrics",
|
||||
"text": "RuleMonitoringCalculatedMetrics"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
|
@ -5434,25 +5643,56 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoring.execution",
|
||||
"type": "Object",
|
||||
"id": "def-common.RuleMonitoringCalculatedMetrics.p50",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "execution",
|
||||
"label": "p50",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ history: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringHistory",
|
||||
"text": "RuleMonitoringHistory"
|
||||
},
|
||||
"[]; calculated_metrics: { p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; success_ratio: number; }; }"
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringCalculatedMetrics.p95",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "p95",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringCalculatedMetrics.p99",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "p99",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringCalculatedMetrics.success_ratio",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "success_ratio",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -5520,6 +5760,197 @@
|
|||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringHistory.outcome",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "outcome",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"warning\" | \"succeeded\" | \"failed\" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRun",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleMonitoringLastRun",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringLastRun",
|
||||
"text": "RuleMonitoringLastRun"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "@kbn/core-saved-objects-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
||||
"section": "def-common.SavedObjectAttributes",
|
||||
"text": "SavedObjectAttributes"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRun.timestamp",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "timestamp",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRun.metrics",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "metrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringLastRunMetrics",
|
||||
"text": "RuleMonitoringLastRunMetrics"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "RuleMonitoringLastRunMetrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleMonitoringLastRunMetrics",
|
||||
"text": "RuleMonitoringLastRunMetrics"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "@kbn/core-saved-objects-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
||||
"section": "def-common.SavedObjectAttributes",
|
||||
"text": "SavedObjectAttributes"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.duration",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "duration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.total_search_duration_ms",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "total_search_duration_ms",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.total_indexing_duration_ms",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "total_indexing_duration_ms",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_detected",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "total_alerts_detected",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_created",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "total_alerts_created",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleMonitoringLastRunMetrics.gap_duration_s",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "gap_duration_s",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -6363,6 +6794,21 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRunOutcomes",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "RuleLastRunOutcomes",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"warning\" | \"succeeded\" | \"failed\""
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleNavigation",
|
||||
|
@ -6553,7 +6999,15 @@
|
|||
"section": "def-common.RuleSnooze",
|
||||
"text": "RuleSnooze"
|
||||
},
|
||||
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; }"
|
||||
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; lastRun?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleLastRun",
|
||||
"text": "RuleLastRun"
|
||||
},
|
||||
" | null | undefined; nextRun?: Date | null | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
|
@ -6817,6 +7271,21 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.RuleLastRunOutcomeValues",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "RuleLastRunOutcomeValues",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"readonly [\"succeeded\", \"warning\", \"failed\"]"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-common.ruleParamsSchema",
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
---
|
||||
import alertingObj from './alerting.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 388 | 0 | 379 | 26 |
|
||||
| 415 | 0 | 406 | 27 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.devdocs.json';
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
|
|||
title: "cloudChat"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloudChat plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
|
||||
---
|
||||
import cloudChatObj from './cloud_chat.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
|
@ -13134,6 +13134,14 @@
|
|||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts"
|
||||
|
@ -13170,6 +13178,14 @@
|
|||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts"
|
||||
|
@ -16439,7 +16455,7 @@
|
|||
"\n{@link TelemetryCounterType}"
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -18272,7 +18288,7 @@
|
|||
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -47463,6 +47479,14 @@
|
|||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts"
|
||||
|
@ -47499,6 +47523,14 @@
|
|||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts"
|
||||
|
@ -56916,7 +56948,7 @@
|
|||
"\n{@link TelemetryCounterType}"
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -63514,7 +63546,7 @@
|
|||
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core
|
|||
title: "core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the core plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
|
||||
---
|
||||
import coreObj from './core.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
@ -9341,7 +9341,7 @@
|
|||
"label": "AggGroupName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"none\" | \"buckets\" | \"metrics\""
|
||||
"\"none\" | \"metrics\" | \"buckets\""
|
||||
],
|
||||
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
||||
"deprecated": false,
|
||||
|
@ -14764,16 +14764,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
@ -14802,16 +14802,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/data_view.ts",
|
||||
|
@ -22458,16 +22458,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
@ -22496,16 +22496,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/data_view.ts",
|
||||
|
|
|
@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/data
|
|||
title: "data"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
||||
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
|
||||
|
||||
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
||||
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
|
|
|
@ -8,14 +8,14 @@ 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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
||||
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
|
||||
|
||||
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
||||
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
|
|
|
@ -31391,7 +31391,7 @@
|
|||
"label": "AggGroupName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"none\" | \"buckets\" | \"metrics\""
|
||||
"\"none\" | \"metrics\" | \"buckets\""
|
||||
],
|
||||
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -8,14 +8,14 @@ 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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
||||
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
|
||||
|
||||
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
||||
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
@ -1912,16 +1912,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
@ -1950,16 +1950,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/data_view.ts",
|
||||
|
@ -7121,16 +7121,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => void"
|
||||
],
|
||||
|
@ -7152,16 +7152,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/field_list.ts",
|
||||
|
@ -10205,16 +10205,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
@ -10243,16 +10243,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/data_view.ts",
|
||||
|
@ -17579,16 +17579,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
@ -17617,16 +17617,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/data_view.ts",
|
||||
|
@ -23777,16 +23777,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => void"
|
||||
],
|
||||
|
@ -23808,16 +23808,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/field_list.ts",
|
||||
|
@ -25054,16 +25054,16 @@
|
|||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewField",
|
||||
"text": "DataViewField"
|
||||
"section": "def-common.FieldSpec",
|
||||
"text": "FieldSpec"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -216,9 +216,9 @@ so TS and code-reference navigation might not highlight them. |
|
|||
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [plugin.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 |
|
||||
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
@ -112,7 +112,7 @@
|
|||
"label": "CRAWLERS_INDEX",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\".ent-search-actastic-crawler2_configurations\""
|
||||
"\".ent-search-actastic-crawler2_configurations_v2\""
|
||||
],
|
||||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
@ -1499,7 +1499,7 @@
|
|||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
|
||||
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1519,7 +1519,7 @@
|
|||
"label": "IEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1534,7 +1534,7 @@
|
|||
"label": "IValidatedEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
|
||||
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
|
||||
|
|
|
@ -299,13 +299,13 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.Dimensions.metric",
|
||||
"type": "CompoundType",
|
||||
"id": "def-common.Dimensions.metrics",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "metric",
|
||||
"label": "metrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
"(string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
|
@ -313,7 +313,7 @@
|
|||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
" | undefined"
|
||||
")[]"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
|
@ -542,7 +542,7 @@
|
|||
"section": "def-common.MosaicVisConfig",
|
||||
"text": "MosaicVisConfig"
|
||||
},
|
||||
" extends VisCommonConfig"
|
||||
" extends Omit<VisCommonConfig, \"metrics\" | \"metricsToLabels\">"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
|
@ -550,21 +550,20 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.MosaicVisConfig.buckets",
|
||||
"type": "Array",
|
||||
"id": "def-common.MosaicVisConfig.metric",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "buckets",
|
||||
"label": "metric",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(string | ",
|
||||
"string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
")[] | undefined"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
|
@ -625,6 +624,20 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.PartitionVisParams.metricsToLabels",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "metricsToLabels",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: string; }"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.PartitionVisParams.labels",
|
||||
|
@ -797,21 +810,13 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.PieVisConfig.buckets",
|
||||
"type": "Array",
|
||||
"id": "def-common.PieVisConfig.partitionByColumn",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "buckets",
|
||||
"label": "partitionByColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
")[] | undefined"
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
|
@ -926,28 +931,6 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.TreemapVisConfig.buckets",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "buckets",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
")[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionPartitionVis",
|
||||
"id": "def-common.TreemapVisConfig.nestedLegend",
|
||||
|
@ -977,7 +960,7 @@
|
|||
"section": "def-common.WaffleVisConfig",
|
||||
"text": "WaffleVisConfig"
|
||||
},
|
||||
" extends VisCommonConfig"
|
||||
" extends Omit<VisCommonConfig, \"buckets\">"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressions
|
|||
title: "expressions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressions plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
||||
Adds expression runtime to Kibana
|
||||
|
||||
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
||||
Contact [Visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
@ -8689,6 +8689,76 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.getFileDataIndexName",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFileDataIndexName",
|
||||
"description": [
|
||||
"\nReturns the index name for File data (chunks) storage for a given integration"
|
||||
],
|
||||
"signature": [
|
||||
"(integrationName: string) => string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/services/file_storage.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.getFileDataIndexName.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "integrationName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/services/file_storage.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.getFileMetadataIndexName",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFileMetadataIndexName",
|
||||
"description": [
|
||||
"\nReturns the index name for File Metadata storage for a given integration"
|
||||
],
|
||||
"signature": [
|
||||
"(integrationName: string) => string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/services/file_storage.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.getFileMetadataIndexName.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "integrationName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/services/file_storage.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.isValidNamespace",
|
||||
|
@ -15130,7 +15200,7 @@
|
|||
"label": "FleetServerAgentComponentStatus",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"degraded\" | \"starting\" | \"configuring\" | \"healthy\" | \"failed\" | \"stopping\" | \"stopped\""
|
||||
"\"failed\" | \"degraded\" | \"starting\" | \"configuring\" | \"healthy\" | \"stopping\" | \"stopped\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
---
|
||||
import fleetObj from './fleet.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1016 | 3 | 913 | 18 |
|
||||
| 1020 | 3 | 915 | 18 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
"section": "def-common.HttpSetup",
|
||||
"text": "HttpSetup"
|
||||
},
|
||||
") => void"
|
||||
", isCloudEnabled: boolean) => void"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -57,28 +57,37 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.setup.$2",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isCloudEnabled",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.fetchActiveGuideState$",
|
||||
"id": "def-public.GuidedOnboardingApi.fetchPluginState$",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "fetchActiveGuideState$",
|
||||
"label": "fetchPluginState$",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
"PluginState",
|
||||
" | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -113,21 +122,15 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.updateGuideState",
|
||||
"id": "def-public.GuidedOnboardingApi.updatePluginState",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "updateGuideState",
|
||||
"label": "updatePluginState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(newState: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
", panelState: boolean) => Promise<{ state: ",
|
||||
"(state: { status?: ",
|
||||
"PluginStatus",
|
||||
" | undefined; guide?: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
|
@ -135,6 +138,8 @@
|
|||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
" | undefined; }, panelState: boolean) => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -143,28 +148,56 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.updateGuideState.$1",
|
||||
"id": "def-public.GuidedOnboardingApi.updatePluginState.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "newState",
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.updatePluginState.$1.status",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "status",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"PluginStatus",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.updatePluginState.$1.guide",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "guide",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.updateGuideState.$2",
|
||||
"id": "def-public.GuidedOnboardingApi.updatePluginState.$2",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "panelState",
|
||||
|
@ -204,14 +237,8 @@
|
|||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
" | undefined) => Promise<{ state: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
" | undefined) => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -264,6 +291,54 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.deactivateGuide",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "deactivateGuide",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(guide: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
") => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.deactivateGuide.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "guide",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.completeGuide",
|
||||
|
@ -280,14 +355,8 @@
|
|||
"section": "def-common.GuideId",
|
||||
"text": "GuideId"
|
||||
},
|
||||
") => Promise<{ state: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
") => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -419,14 +488,8 @@
|
|||
"section": "def-common.GuideStepIds",
|
||||
"text": "GuideStepIds"
|
||||
},
|
||||
") => Promise<{ state: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
") => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -502,14 +565,8 @@
|
|||
"section": "def-common.GuideStepIds",
|
||||
"text": "GuideStepIds"
|
||||
},
|
||||
") => Promise<{ state: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
") => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -603,14 +660,8 @@
|
|||
"label": "completeGuidedOnboardingForIntegration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(integration?: string | undefined) => Promise<{ state: ",
|
||||
{
|
||||
"pluginId": "@kbn/guided-onboarding",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnGuidedOnboardingPluginApi",
|
||||
"section": "def-common.GuideState",
|
||||
"text": "GuideState"
|
||||
},
|
||||
"(integration?: string | undefined) => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
|
@ -635,6 +686,24 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.skipGuidedOnboarding",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "skipGuidedOnboarding",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => Promise<{ pluginState: ",
|
||||
"PluginState",
|
||||
"; } | undefined>"
|
||||
],
|
||||
"path": "src/plugins/guided_onboarding/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "guidedOnboarding",
|
||||
"id": "def-public.GuidedOnboardingApi.isGuidePanelOpen$",
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [Journey Onboarding](https://github.com/orgs/elastic/teams/platform-onbo
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 37 | 0 | 37 | 1 |
|
||||
| 43 | 0 | 43 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -1856,7 +1856,7 @@
|
|||
"section": "def-server.TutorialContext",
|
||||
"text": "TutorialContext"
|
||||
},
|
||||
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; id: string; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
|
||||
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { name: string; category: \"metrics\" | \"other\" | \"security\" | \"logging\"; id: string; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
|
||||
],
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1894,7 +1894,7 @@
|
|||
"label": "TutorialSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly id: string; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
|
||||
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly name: string; readonly category: \"metrics\" | \"other\" | \"security\" | \"logging\"; readonly id: string; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
|
||||
],
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
---
|
||||
import kbnAceObj from './kbn_ace.devdocs.json';
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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-alerts
|
|||
title: "@kbn/alerts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
|
||||
---
|
||||
import kbnAlertsObj from './kbn_alerts.devdocs.json';
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
|
||||
---
|
||||
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';
|
||||
|
|
|
@ -2193,7 +2193,7 @@
|
|||
"\n{@link TelemetryCounterType}"
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -2532,7 +2532,7 @@
|
|||
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
||||
],
|
||||
"signature": [
|
||||
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
||||
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
||||
],
|
||||
"path": "packages/analytics/client/src/events/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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-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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
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: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
|
||||
---
|
||||
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight
|
|||
title: "@kbn/analytics-shippers-gainsight"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-gainsight plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight']
|
||||
---
|
||||
import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
|
|||
title: "@kbn/apm-config-loader"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-config-loader plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
|
||||
---
|
||||
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';
|
||||
|
|
|
@ -1072,7 +1072,7 @@
|
|||
},
|
||||
"[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'host.architecture': string; 'host.hostname': string; 'http.request.method': string; 'http.response.status_code': number; 'kubernetes.pod.uid': string; 'kubernetes.pod.name': string; 'metricset.name': string; observer: ",
|
||||
"Observer",
|
||||
"; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.action': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.resource': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.name': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }>"
|
||||
"; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.language.name': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.action': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.resource': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.name': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }>"
|
||||
],
|
||||
"path": "packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1168,7 +1168,7 @@
|
|||
},
|
||||
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.architecture'?: string | undefined; 'host.hostname'?: string | undefined; 'http.request.method'?: string | undefined; 'http.response.status_code'?: number | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ",
|
||||
"Observer",
|
||||
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.action'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
|
||||
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.language.name'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.action'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
|
||||
],
|
||||
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1224,7 +1224,7 @@
|
|||
},
|
||||
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.architecture'?: string | undefined; 'host.hostname'?: string | undefined; 'http.request.method'?: string | undefined; 'http.response.status_code'?: number | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ",
|
||||
"Observer",
|
||||
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.action'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.resource'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
|
||||
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.language.name'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.action'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.resource'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
|
||||
],
|
||||
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
|
|||
title: "@kbn/apm-synthtrace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-synthtrace plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
|
||||
---
|
||||
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
|
|||
title: "@kbn/apm-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-utils plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
|
||||
---
|
||||
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
|
|||
title: "@kbn/axe-config"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/axe-config plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
|
||||
---
|
||||
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components
|
|||
title: "@kbn/cases-components"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/cases-components plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components']
|
||||
---
|
||||
import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons
|
|||
title: "@kbn/chart-icons"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/chart-icons plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons']
|
||||
---
|
||||
import kbnChartIconsObj from './kbn_chart_icons.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
|
|||
title: "@kbn/ci-stats-core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ci-stats-core plugin
|
||||
date: 2022-11-14
|
||||
date: 2022-11-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
|
||||
---
|
||||
import kbnCiStatsCoreObj from './kbn_ci_stats_core.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