diff --git a/.buildkite/scripts/steps/checks.sh b/.buildkite/scripts/steps/checks.sh index bffb919eaa8c9..9937a25758e41 100755 --- a/.buildkite/scripts/steps/checks.sh +++ b/.buildkite/scripts/steps/checks.sh @@ -11,7 +11,6 @@ export DISABLE_BOOTSTRAP_VALIDATION=false .buildkite/scripts/steps/checks/telemetry.sh .buildkite/scripts/steps/checks/ts_projects.sh .buildkite/scripts/steps/checks/jest_configs.sh -.buildkite/scripts/steps/checks/doc_api_changes.sh .buildkite/scripts/steps/checks/kbn_pm_dist.sh .buildkite/scripts/steps/checks/plugin_list_docs.sh .buildkite/scripts/steps/checks/bundle_limits.sh diff --git a/.buildkite/scripts/steps/checks/doc_api_changes.sh b/.buildkite/scripts/steps/checks/doc_api_changes.sh deleted file mode 100755 index 73a2bb9409d02..0000000000000 --- a/.buildkite/scripts/steps/checks/doc_api_changes.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env bash - -set -euo pipefail - -source .buildkite/scripts/common/util.sh - -echo --- Check Doc API Changes -checks-reporter-with-killswitch "Check Doc API Changes" \ - node scripts/check_published_api_changes diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4c2348df2ffbe..2682f1fc9c7c9 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -257,9 +257,9 @@ #CC# /packages/kbn-expect/ @elastic/kibana-operations /.buildkite/ @elastic/kibana-operations -# Scalability testing -/packages/kbn-performance-testing-dataset-extractor/ @elastic/kibana-scalability-testing -/packages/kbn-scalability-simulation-generator/ @elastic/kibana-scalability-testing +# Performance testing +/packages/kbn-performance-testing-dataset-extractor/ @elastic/kibana-performance-testing +/packages/kbn-scalability-simulation-generator/ @elastic/kibana-performance-testing # Quality Assurance /src/dev/code_coverage @elastic/kibana-qa @@ -291,7 +291,6 @@ /packages/kbn-logging-mocks/ @elastic/kibana-core /packages/kbn-http-tools/ @elastic/kibana-core /src/plugins/saved_objects_management/ @elastic/kibana-core -/src/dev/run_check_published_api_changes.ts @elastic/kibana-core /src/plugins/advanced_settings/ @elastic/kibana-core /x-pack/plugins/global_search_bar/ @elastic/kibana-core /test/analytics @elastic/kibana-core diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 10c19d9c293c0..a3c9c51cd2716 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 692a2494761fb..2362df77d806d 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index f8402bc28bcca..33f5b265739b2 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github summary: API docs for the aiops plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 27eefd2cead9b..f47a91695fd1e 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -3036,7 +3036,15 @@ "section": "def-server.BulkEditError", "text": "BulkEditError" }, - "[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise; unsnooze: ({ id }: { id: string; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + "[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise; snooze: ({ id, snoozeSchedule, }: { id: string; snoozeSchedule: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnoozeSchedule", + "text": "RuleSnoozeSchedule" + }, + "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", @@ -4466,10 +4474,13 @@ { "parentPluginId": "alerting", "id": "def-common.RRuleRecord.bymonthday", - "type": "number", + "type": "Array", "tags": [], "label": "bymonthday", "description": [], + "signature": [ + "number[]" + ], "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "deprecated": false }, @@ -5241,6 +5252,71 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule", + "type": "Interface", + "tags": [], + "label": "RuleSnoozeSchedule", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.duration", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.rRule", + "type": "CompoundType", + "tags": [], + "label": "rRule", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + "> & Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + ", \"dtstart\" | \"tzid\">" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.RuleStateNavigation", @@ -5942,23 +6018,7 @@ "label": "RuleSnooze", "description": [], "signature": [ - "{ duration: number; rRule: Partial<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - "> & Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - ", \"dtstart\" | \"tzid\">; id?: string | undefined; }[]" + "{ duration: number; rRule: SnoozeRRule; id?: string | undefined; }[]" ], "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index a7c2987408ce6..a9a38362bad81 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 359 | 0 | 350 | 20 | +| 363 | 0 | 354 | 20 | ## Client diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 098d7ad098eeb..22d5292e01528 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 469707ac8dbe1..a4e6037e7b41c 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index c05558298f1d7..d91d6b14b30bf 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 3641ac6f9a281..964bbe8ce5872 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 6dbf6ca1e47ec..9e2f532071351 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 0a2ffe1342ce0..ac24cd50d2d6b 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 8bb66c999e055..34b7f273f271e 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index a1ecc0dfc59ca..c6ac3bd0c1ee7 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index e3589d8616fd6..5d5de2b8f163c 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 01ac2653e11a5..f85640721d867 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 83f05f2617239..6f06c69c9a35c 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -11089,13 +11089,7 @@ "{@link LoggingServiceSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LoggingServiceSetup", - "text": "LoggingServiceSetup" - } + "LoggingServiceSetup" ], "path": "src/core/server/index.ts", "deprecated": false @@ -19428,14 +19422,67 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.LoggerConfigType", + "type": "Interface", + "tags": [], + "label": "LoggerConfigType", + "description": [ + "\r\nDescribes the configuration of a given logger.\r\n" + ], + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.LoggerConfigType.appenders", + "type": "Array", + "tags": [], + "label": "appenders", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.LoggerConfigType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.LoggerConfigType.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [], + "signature": [ + "\"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"" + ], + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.LoggerContextConfigInput", "type": "Interface", "tags": [], "label": "LoggerContextConfigInput", - "description": [], - "path": "src/core/server/logging/logging_config.ts", + "description": [ + "\r\nInput used to configure logging dynamically using {@link LoggingServiceSetup.configure}" + ], + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, "children": [ { @@ -19447,24 +19494,12 @@ "description": [], "signature": [ "Record | Map | undefined" ], - "path": "src/core/server/logging/logging_config.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false }, { @@ -19475,9 +19510,10 @@ "label": "loggers", "description": [], "signature": [ - "Readonly<{} & { name: string; level: \"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; appenders: string[]; }>[] | undefined" + "LoggerConfigType", + "[] | undefined" ], - "path": "src/core/server/logging/logging_config.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false } ], @@ -19540,9 +19576,9 @@ "tags": [], "label": "LoggingServiceSetup", "description": [ - "\nProvides APIs to plugins for customizing the plugin's logger." + "\r\nProvides APIs to plugins for customizing the plugin's logger." ], - "path": "src/core/server/logging/logging_service.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, "children": [ { @@ -19552,22 +19588,16 @@ "tags": [], "label": "configure", "description": [ - "\nCustomizes the logging config for the plugin's context.\n" + "\r\nCustomizes the logging config for the plugin's context.\r\n" ], "signature": [ "(config$: ", "Observable", "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LoggerContextConfigInput", - "text": "LoggerContextConfigInput" - }, + "LoggerContextConfigInput", ">) => void" ], - "path": "src/core/server/logging/logging_service.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, "children": [ { @@ -19580,16 +19610,10 @@ "signature": [ "Observable", "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LoggerContextConfigInput", - "text": "LoggerContextConfigInput" - }, + "LoggerContextConfigInput", ">" ], - "path": "src/core/server/logging/logging_service.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, "isRequired": true } @@ -24263,7 +24287,7 @@ " | ", "RollingFileAppenderConfig" ], - "path": "src/core/server/logging/appenders/appenders.ts", + "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -26782,20 +26806,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "core", - "id": "def-server.LoggerConfigType", - "type": "Type", - "tags": [], - "label": "LoggerConfigType", - "description": [], - "signature": [ - "{ readonly name: string; readonly level: \"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; readonly appenders: string[]; }" - ], - "path": "src/core/server/logging/logging_config.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "core", "id": "def-server.LogMeta", diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 457357dc2dd88..42dd8263b124e 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 946 | 33 | +| 2527 | 15 | 940 | 29 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index ce7ea096eac82..f71fa5999f448 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 946 | 33 | +| 2527 | 15 | 940 | 29 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index cc608e2ea8955..ff3e958e0529f 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 946 | 33 | +| 2527 | 15 | 940 | 29 | ## Client diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 83f94398f3a94..23bd766d9ae5d 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 946 | 33 | +| 2527 | 15 | 940 | 29 | ## Client diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 93633f9326843..bac90d13acfc3 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 946 | 33 | +| 2527 | 15 | 940 | 29 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 58ef33efc8294..1992adc2ffa81 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 689e8aed6348e..a05ab42c32be8 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 54adffe4f115b..80ea33452576a 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 6bfac6736a81b..a9cbb8be306c9 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -11713,7 +11713,9 @@ }, ", field: string | ", "DataViewFieldBase", - ", values: any, operation: string, index: string) => ", + ", values: any, operation: string, index: ", + "DataViewBase", + ") => ", "Filter", "[]" ], @@ -11780,10 +11782,15 @@ { "parentPluginId": "data", "id": "def-public.esFilters.generateFilters.$5", - "type": "string", + "type": "Object", "tags": [], "label": "index", "description": [], + "signature": [ + "{ fields: ", + "DataViewFieldBase", + "[]; id?: string | undefined; title: string; }" + ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false } @@ -13287,113 +13294,6 @@ ], "path": "src/plugins/data/public/index.ts", "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getNumberHistogramIntervalByDatatableColumn", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getDateHistogramMetaDataByDatatableColumn", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", defaults?: Partial<{ timeZone: string; }>) => { interval: string | undefined; timeZone: string | undefined; timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; } | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$2", - "type": "Object", - "tags": [], - "label": "defaults", - "description": [], - "signature": [ - "{ timeZone?: string | undefined; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false - } - ] } ] }, @@ -13603,50 +13503,6 @@ "deprecated": false } ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.checkColumnForPrecisionError", - "type": "Function", - "tags": [], - "label": "checkColumnForPrecisionError", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - "Serializable" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.checkColumnForPrecisionError.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/tabify/utils.ts", - "deprecated": false - } - ] } ], "initialIsOpen": false @@ -22209,6 +22065,66 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta", + "type": "Function", + "tags": [], + "label": "getDateHistogramMeta", + "description": [ + "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." + ], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ", defaults?: Partial<{ timeZone: string; }>) => DateHistogramMeta | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$2", + "type": "Object", + "tags": [], + "label": "defaults", + "description": [], + "signature": [ + "Partial<{ timeZone: string; }>" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.DatatableUtilitiesService.getDataView", @@ -22409,6 +22325,52 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval", + "type": "Function", + "tags": [], + "label": "getNumberHistogramInterval", + "description": [ + "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." + ], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => number | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.DatatableUtilitiesService.getTotalCount", @@ -22453,6 +22415,51 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.hasPrecisionError", + "type": "Function", + "tags": [], + "label": "hasPrecisionError", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => ", + "Serializable" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.hasPrecisionError.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.DatatableUtilitiesService.isFilterable", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index cb3dc6cd4f132..3ba5beb5d04d8 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3379 | 35 | 2525 | 21 | +| 3372 | 35 | 2518 | 21 | ## Client diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 8bf70e994cdff..ba274a046a393 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -1276,7 +1276,9 @@ }, ", field: string | ", "DataViewFieldBase", - ", values: any, operation: string, index: string) => ", + ", values: any, operation: string, index: ", + "DataViewBase", + ") => ", "Filter", "[]" ], @@ -1357,14 +1359,14 @@ { "parentPluginId": "data", "id": "def-public.generateFilters.$5", - "type": "string", + "type": "Object", "tags": [], "label": "index", "description": [ "- Index string to generate filters for" ], "signature": [ - "string" + "DataViewBase" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index f57b367a5af9c..2a81780f25e56 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3379 | 35 | 2525 | 21 | +| 3372 | 35 | 2518 | 21 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 81ea72cf187d3..deba3008b0de7 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -11355,52 +11355,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.checkColumnForPrecisionError", - "type": "Function", - "tags": [], - "label": "checkColumnForPrecisionError", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - "Serializable" - ], - "path": "src/plugins/data/common/search/tabify/utils.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.checkColumnForPrecisionError.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/tabify/utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.cidrToAst", @@ -12515,75 +12469,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.getDateHistogramMetaDataByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getDateHistogramMetaDataByDatatableColumn", - "description": [ - "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", defaults?: Partial<{ timeZone: string; }>) => { interval: string | undefined; timeZone: string | undefined; timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; } | undefined" - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$2", - "type": "Object", - "tags": [], - "label": "defaults", - "description": [], - "signature": [ - "Partial<{ timeZone: string; }>" - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.getDateRangeBucketAgg", @@ -13483,53 +13368,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.getNumberHistogramIntervalByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getNumberHistogramIntervalByDatatableColumn", - "description": [ - "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getNumberHistogramIntervalByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.getPercentileRanksMetricAgg", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 2615366ca0687..5f0239c3ee434 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3379 | 35 | 2525 | 21 | +| 3372 | 35 | 2518 | 21 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 1c545320dfa49..6f2cdb2350507 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 0852c99a6e1a4..692d50ae66a77 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 2ccdee0a3b82b..b2dff4fcae8ef 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 4b6c4bae0e3af..ccf8f12cb276c 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 72831bc9ded5b..0de7c1db684e6 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 778cb4d6e1751..f5fddc4eb32e1 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 7facd074c2acb..85c1f61e6d944 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index e38386196a6d2..4e41da90b698a 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 504cffb064a67..4dea92a222265 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index b58a748a1a60b..6740276120bc4 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 389b0894a89a9..6584490e7c347 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 11e521017e343..ec575d551a733 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 2238816b57e16..a6737f6650638 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index b6bf33acfe3ba..c8873882cc3a3 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 0cc86f4b42a8a..319b3b5198e43 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 623e460290d63..b218b8f933f54 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 7bc071d2ce1b9..3ad01719d1506 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 8940d86a797e1..3ca4853bd2823 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index ff694709f7468..42f392650f117 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 272a4abc34939..71115486d3599 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 0794056f7d22b..ff3eb921466cc 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.devdocs.json b/api_docs/expression_heatmap.devdocs.json index 4b3586b153f25..0476516cb26a1 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -580,6 +580,14 @@ }, "; chartsThemeService: ", "Theme", + "; datatableUtilities: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DatatableUtilitiesService", + "text": "DatatableUtilitiesService" + }, "; onClickValue: (data: { data: { table: Pick<", { "pluginId": "expressions", diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index b3e0525b6e118..0f275e9b6c018 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 774f21deb4752..b8c422da05f27 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index aca8c50c65a89..46b37e71cbf25 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 7f0fc043f8fbd..b4e4ef9bf5cf6 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 0c67b86fe67f7..b4bddb1883e5b 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 378bb8a424b39..e5bf549f9d90e 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index 75cc7a943d6e2..1ff5125f23082 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index a358d431ac66c..fc8c1da0baa60 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index d62018f89f5d5..efc368456ed80 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 089fd9c5b512e..a54e704f338e7 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index c56218c270fcf..702747e6b7379 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 590de06e88f9d..0ea745c09724b 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 73229785be96e..de50b4c79027f 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 0af077ff4507d..c08489d474686 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 956fdb251c79e..71008fbb011f1 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 6ee57d083b9c3..b6ace962da867 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.mdx b/api_docs/home.mdx index d208fea06f2fd..cb4efc7394ae2 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 23557b805f7c7..0abd7dafe1dfc 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 8b8d77ba53704..237e1d188a1eb 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 2d57be66434db..2af55a03958b9 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 7f09991ac7762..47fb922cea12a 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 28d0f047ccb8b..e71b5ee9c4570 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 19f3295cf76d7..85fb794b3cc01 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 4ebda4318d9c9..8161553290b5a 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 550ac8cb20799..64b400887b5f1 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index 3f4cc7c569566..d94411838ac93 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 3136af1376608..076fb0b37b285 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index 80bdfe134b71b..f43a920340a8a 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -4,7 +4,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 summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index e8e4cae95cdfc..2c2d370c55530 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -4,7 +4,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 summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index a42f68ad5bfbe..0313b6a4bc96c 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -4,7 +4,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 summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 13b083414db81..7de051d50bd1d 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 554348a0e5c01..d616defe56978 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 5ed146c303a42..d7eefb5218955 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index f78626fe88e42..995e5e5902dca 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index 494bc11e96bf9..d70c566be14ef 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index 5601cd9a16408..2415099300f2a 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 8e807b6ae5c70..4f87c899a1c89 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 0ba00e91f34ba..a252ee5af2af1 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index d58003cb99d4b..a08c2708487a1 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index d6fc0458ba3e0..ec54a8a98a21b 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 46796f8545b8f..152e372f9838e 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 4652804afdd22..43254c641247c 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 30738e0b3d7d3..aac83c2bb4ae5 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index 027bb3a07121b..b4a987b6c9c8a 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 176253ee51594..3014690067bf7 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index 052627586ab3f..ac90c830633e2 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index c74c14c8e1f77..ced92a3a32d9a 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-browser-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index 498d78df692f5..7a8ef3b91471a 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-common plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 0c501894d36f7..a813e133f6627 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 2ec238740efcb..6d78b0bfac021 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index a05a15e7934de..8aeffa4b0a86a 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 7483e86df0d4f..5c4517d534751 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index b421b8563e6a7..57edcacd8f414 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index a5bb61d37be36..96861c44d2bd2 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index 225559552e479..c39204be565b9 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server.devdocs.json b/api_docs/kbn_core_logging_server.devdocs.json new file mode 100644 index 0000000000000..fb838f8e4c7e0 --- /dev/null +++ b/api_docs/kbn_core_logging_server.devdocs.json @@ -0,0 +1,984 @@ +{ + "id": "@kbn/core-logging-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.ConsoleAppenderConfig", + "type": "Interface", + "tags": [], + "label": "ConsoleAppenderConfig", + "description": [ + "\nConfiguration of a console appender" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/console.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.ConsoleAppenderConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"console\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/console.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.ConsoleAppenderConfig.layout", + "type": "CompoundType", + "tags": [], + "label": "layout", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.PatternLayoutConfigType", + "text": "PatternLayoutConfigType" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.JsonLayoutConfigType", + "text": "JsonLayoutConfigType" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/console.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.FileAppenderConfig", + "type": "Interface", + "tags": [], + "label": "FileAppenderConfig", + "description": [ + "\nConfiguration of a file appender" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/file.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.FileAppenderConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.FileAppenderConfig.layout", + "type": "CompoundType", + "tags": [], + "label": "layout", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.PatternLayoutConfigType", + "text": "PatternLayoutConfigType" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.JsonLayoutConfigType", + "text": "JsonLayoutConfigType" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.FileAppenderConfig.fileName", + "type": "string", + "tags": [], + "label": "fileName", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/file.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.JsonLayoutConfigType", + "type": "Interface", + "tags": [], + "label": "JsonLayoutConfigType", + "description": [ + "\nConfiguration of a json layout" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.JsonLayoutConfigType.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"json\"" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerConfigType", + "type": "Interface", + "tags": [], + "label": "LoggerConfigType", + "description": [ + "\nDescribes the configuration of a given logger.\n" + ], + "path": "packages/core/logging/core-logging-server/src/logger.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerConfigType.appenders", + "type": "Array", + "tags": [], + "label": "appenders", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/logging/core-logging-server/src/logger.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerConfigType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/core/logging/core-logging-server/src/logger.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerConfigType.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [], + "signature": [ + "\"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"" + ], + "path": "packages/core/logging/core-logging-server/src/logger.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerContextConfigInput", + "type": "Interface", + "tags": [], + "label": "LoggerContextConfigInput", + "description": [ + "\nInput used to configure logging dynamically using {@link LoggingServiceSetup.configure}" + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerContextConfigInput.appenders", + "type": "CompoundType", + "tags": [], + "label": "appenders", + "description": [], + "signature": [ + "Record | Map | undefined" + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggerContextConfigInput.loggers", + "type": "Array", + "tags": [], + "label": "loggers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.LoggerConfigType", + "text": "LoggerConfigType" + }, + "[] | undefined" + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggingServiceSetup", + "type": "Interface", + "tags": [], + "label": "LoggingServiceSetup", + "description": [ + "\nProvides APIs to plugins for customizing the plugin's logger." + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggingServiceSetup.configure", + "type": "Function", + "tags": [], + "label": "configure", + "description": [ + "\nCustomizes the logging config for the plugin's context.\n" + ], + "signature": [ + "(config$: ", + "Observable", + "<", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.LoggerContextConfigInput", + "text": "LoggerContextConfigInput" + }, + ">) => void" + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LoggingServiceSetup.configure.$1", + "type": "Object", + "tags": [], + "label": "config$", + "description": [], + "signature": [ + "Observable", + "<", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.LoggerContextConfigInput", + "text": "LoggerContextConfigInput" + }, + ">" + ], + "path": "packages/core/logging/core-logging-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfig", + "type": "Interface", + "tags": [], + "label": "MetaRewritePolicyConfig", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"meta\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfig.mode", + "type": "CompoundType", + "tags": [], + "label": "mode", + "description": [ + "\nThe 'mode' specifies what action to perform on the specified properties.\n - 'update' updates an existing property at the provided 'path'.\n - 'remove' removes an existing property at the provided 'path'." + ], + "signature": [ + "\"update\" | \"remove\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfig.properties", + "type": "Array", + "tags": [], + "label": "properties", + "description": [ + "\nThe properties to modify.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.MetaRewritePolicyConfigProperty", + "text": "MetaRewritePolicyConfigProperty" + }, + "[]" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfigProperty", + "type": "Interface", + "tags": [], + "label": "MetaRewritePolicyConfigProperty", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfigProperty.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.MetaRewritePolicyConfigProperty.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean | null | undefined" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.NumericRollingStrategyConfig", + "type": "Interface", + "tags": [], + "label": "NumericRollingStrategyConfig", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.NumericRollingStrategyConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"numeric\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.NumericRollingStrategyConfig.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [ + "\nThe suffix pattern to apply when renaming a file. The suffix will be applied\nafter the `appender.fileName` file name, but before the file extension.\n\nMust include `%i`, as it is the value that will be converted to the file index\n" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.NumericRollingStrategyConfig.max", + "type": "number", + "tags": [], + "label": "max", + "description": [ + "\nThe maximum number of files to keep. Once this number is reached, oldest\nfiles will be deleted. Defaults to `7`" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.PatternLayoutConfigType", + "type": "Interface", + "tags": [], + "label": "PatternLayoutConfigType", + "description": [ + "\nConfiguration of a pattern layout" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.PatternLayoutConfigType.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"pattern\"" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.PatternLayoutConfigType.highlight", + "type": "CompoundType", + "tags": [], + "label": "highlight", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.PatternLayoutConfigType.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RewriteAppenderConfig", + "type": "Interface", + "tags": [], + "label": "RewriteAppenderConfig", + "description": [ + "\nConfiguration of a rewrite appender" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RewriteAppenderConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"rewrite\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RewriteAppenderConfig.appenders", + "type": "Array", + "tags": [], + "label": "appenders", + "description": [ + "\nThe {@link Appender | appender(s)} to pass the log event to after\nimplementing the specified rewrite policy." + ], + "signature": [ + "string[]" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RewriteAppenderConfig.policy", + "type": "Object", + "tags": [], + "label": "policy", + "description": [ + "\nThe {@link RewritePolicy | policy} to use to manipulate the provided data." + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.MetaRewritePolicyConfig", + "text": "MetaRewritePolicyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig", + "type": "Interface", + "tags": [], + "label": "RollingFileAppenderConfig", + "description": [ + "\nConfiguration of a rolling-file appender" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"rolling-file\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig.layout", + "type": "CompoundType", + "tags": [], + "label": "layout", + "description": [ + "\nThe layout to use when writing log entries" + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.PatternLayoutConfigType", + "text": "PatternLayoutConfigType" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.JsonLayoutConfigType", + "text": "JsonLayoutConfigType" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig.fileName", + "type": "string", + "tags": [], + "label": "fileName", + "description": [ + "\nThe absolute path of the file to write to." + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig.policy", + "type": "CompoundType", + "tags": [], + "label": "policy", + "description": [ + "\nThe {@link TriggeringPolicy | policy} to use to determine if a rollover should occur." + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.SizeLimitTriggeringPolicyConfig", + "text": "SizeLimitTriggeringPolicyConfig" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.TimeIntervalTriggeringPolicyConfig", + "text": "TimeIntervalTriggeringPolicyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingFileAppenderConfig.strategy", + "type": "Object", + "tags": [], + "label": "strategy", + "description": [ + "\nThe {@link RollingStrategy | rollout strategy} to use for rolling." + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.NumericRollingStrategyConfig", + "text": "NumericRollingStrategyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.SizeLimitTriggeringPolicyConfig", + "type": "Interface", + "tags": [], + "label": "SizeLimitTriggeringPolicyConfig", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.SizeLimitTriggeringPolicyConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"size-limit\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.SizeLimitTriggeringPolicyConfig.size", + "type": "Object", + "tags": [], + "label": "size", + "description": [ + "\nThe minimum size the file must have to roll over." + ], + "signature": [ + "ByteSizeValue" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.TimeIntervalTriggeringPolicyConfig", + "type": "Interface", + "tags": [], + "label": "TimeIntervalTriggeringPolicyConfig", + "description": [], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.TimeIntervalTriggeringPolicyConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"time-interval\"" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.TimeIntervalTriggeringPolicyConfig.interval", + "type": "Object", + "tags": [], + "label": "interval", + "description": [ + "\nHow often a rollover should occur.\n" + ], + "signature": [ + "moment.Duration" + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.TimeIntervalTriggeringPolicyConfig.modulate", + "type": "boolean", + "tags": [], + "label": "modulate", + "description": [ + "\nIndicates whether the interval should be adjusted to cause the next rollover to occur on the interval boundary.\n\nFor example, if the interval is `4h` and the current hour is 3 am then\nthe first rollover will occur at 4 am and then next ones will occur at 8 am, noon, 4pm, etc.\nThe default value is true." + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.AppenderConfigType", + "type": "Type", + "tags": [], + "label": "AppenderConfigType", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.ConsoleAppenderConfig", + "text": "ConsoleAppenderConfig" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.FileAppenderConfig", + "text": "FileAppenderConfig" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.RewriteAppenderConfig", + "text": "RewriteAppenderConfig" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.RollingFileAppenderConfig", + "text": "RollingFileAppenderConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.LayoutConfigType", + "type": "Type", + "tags": [], + "label": "LayoutConfigType", + "description": [ + "\nConfiguration of a logging layout.\nSee {@link JsonLayoutConfigType} and {@link PatternLayoutConfigType}" + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.PatternLayoutConfigType", + "text": "PatternLayoutConfigType" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.JsonLayoutConfigType", + "text": "JsonLayoutConfigType" + } + ], + "path": "packages/core/logging/core-logging-server/src/layout.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RewritePolicyConfig", + "type": "Type", + "tags": [], + "label": "RewritePolicyConfig", + "description": [ + "\nAvailable rewrite policies which specify what part of a {@link LogRecord}\ncan be modified." + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.MetaRewritePolicyConfig", + "text": "MetaRewritePolicyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rewrite.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.RollingStrategyConfig", + "type": "Type", + "tags": [], + "label": "RollingStrategyConfig", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.NumericRollingStrategyConfig", + "text": "NumericRollingStrategyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server", + "id": "def-server.TriggeringPolicyConfig", + "type": "Type", + "tags": [], + "label": "TriggeringPolicyConfig", + "description": [ + "\nAny of the existing policy's configuration\n\nSee {@link SizeLimitTriggeringPolicyConfig} and {@link TimeIntervalTriggeringPolicyConfig}" + ], + "signature": [ + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.SizeLimitTriggeringPolicyConfig", + "text": "SizeLimitTriggeringPolicyConfig" + }, + " | ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "server", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-server.TimeIntervalTriggeringPolicyConfig", + "text": "TimeIntervalTriggeringPolicyConfig" + } + ], + "path": "packages/core/logging/core-logging-server/src/appenders/rolling_file.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx new file mode 100644 index 0000000000000..c2664520f5a8c --- /dev/null +++ b/api_docs/kbn_core_logging_server.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreLoggingServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-logging-server +title: "@kbn/core-logging-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-logging-server plugin +date: 2022-06-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreLoggingServerObj from './kbn_core_logging_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 56 | 0 | 30 | 0 | + +## Server + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_logging_server_internal.devdocs.json b/api_docs/kbn_core_logging_server_internal.devdocs.json new file mode 100644 index 0000000000000..058b446d5c2a6 --- /dev/null +++ b/api_docs/kbn_core_logging_server_internal.devdocs.json @@ -0,0 +1,184 @@ +{ + "id": "@kbn/core-logging-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.getNextRollingTime", + "type": "Function", + "tags": [], + "label": "getNextRollingTime", + "description": [ + "\nReturn the next rollout time, given current time and rollout interval" + ], + "signature": [ + "(currentTime: number, interval: moment.Duration, modulate: boolean) => number" + ], + "path": "packages/core/logging/core-logging-server-internal/src/appenders/rolling_file/policies/time_interval/get_next_rolling_time.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.getNextRollingTime.$1", + "type": "number", + "tags": [], + "label": "currentTime", + "description": [], + "signature": [ + "number" + ], + "path": "packages/core/logging/core-logging-server-internal/src/appenders/rolling_file/policies/time_interval/get_next_rolling_time.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.getNextRollingTime.$2", + "type": "Object", + "tags": [], + "label": "interval", + "description": [], + "signature": [ + "moment.Duration" + ], + "path": "packages/core/logging/core-logging-server-internal/src/appenders/rolling_file/policies/time_interval/get_next_rolling_time.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.getNextRollingTime.$3", + "type": "boolean", + "tags": [], + "label": "modulate", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/core/logging/core-logging-server-internal/src/appenders/rolling_file/policies/time_interval/get_next_rolling_time.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.PrebootDeps", + "type": "Interface", + "tags": [], + "label": "PrebootDeps", + "description": [], + "path": "packages/core/logging/core-logging-server-internal/src/logging_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.PrebootDeps.loggingSystem", + "type": "Object", + "tags": [], + "label": "loggingSystem", + "description": [], + "signature": [ + "ILoggingSystem" + ], + "path": "packages/core/logging/core-logging-server-internal/src/logging_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.appendersSchema", + "type": "Object", + "tags": [], + "label": "appendersSchema", + "description": [ + "\nConfig schema for validting the shape of the `appenders` key in in {@link LoggerContextConfigType} or\n{@link LoggingConfigType}.\n" + ], + "signature": [ + "Type", + " | Readonly<{ highlight?: boolean | undefined; pattern?: string | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"file\"; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ highlight?: boolean | undefined; pattern?: string | undefined; } & { type: \"pattern\"; }>; fileName: string; }> | Readonly<{} & { type: \"rewrite\"; policy: Readonly<{} & { type: \"meta\"; mode: \"update\" | \"remove\"; properties: Readonly<{ value?: string | number | boolean | null | undefined; } & { path: string; }>[]; }>; appenders: string[]; }> | Readonly<{} & { type: \"rolling-file\"; strategy: ", + "NumericRollingStrategyConfig", + "; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ highlight?: boolean | undefined; pattern?: string | undefined; } & { type: \"pattern\"; }>; policy: Readonly<{} & { size: ", + "ByteSizeValue", + "; type: \"size-limit\"; }> | Readonly<{} & { interval: moment.Duration; type: \"time-interval\"; modulate: boolean; }>; fileName: string; }>>" + ], + "path": "packages/core/logging/core-logging-server-internal/src/appenders/appenders.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.loggerContextConfigSchema", + "type": "Object", + "tags": [], + "label": "loggerContextConfigSchema", + "description": [ + "\nConfig schema for validating the inputs to the {@link LoggingServiceStart.configure} API.\nSee {@link LoggerContextConfigType}.\n" + ], + "signature": [ + "ObjectType", + "<{ appenders: ", + "Type", + ">; loggers: ", + "Type", + "[]>; }>" + ], + "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server-internal", + "id": "def-server.loggerSchema", + "type": "Object", + "tags": [], + "label": "loggerSchema", + "description": [ + "\nConfig schema for validating the `loggers` key in {@link LoggerContextConfigType} or {@link LoggingConfigType}.\n" + ], + "signature": [ + "ObjectType", + "<{ appenders: ", + "Type", + "; name: ", + "Type", + "; level: ", + "Type", + "<\"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\">; }>" + ], + "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", + "deprecated": false, + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx new file mode 100644 index 0000000000000..cc3af53be3195 --- /dev/null +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreLoggingServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-logging-server-internal +title: "@kbn/core-logging-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-logging-server-internal plugin +date: 2022-06-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreLoggingServerInternalObj from './kbn_core_logging_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 9 | 0 | 5 | 1 | + +## Server + +### Objects + + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_core_logging_server_mocks.devdocs.json b/api_docs/kbn_core_logging_server_mocks.devdocs.json new file mode 100644 index 0000000000000..d3ff7df8aee46 --- /dev/null +++ b/api_docs/kbn_core_logging_server_mocks.devdocs.json @@ -0,0 +1,243 @@ +{ + "id": "@kbn/core-logging-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingServiceMock", + "type": "Object", + "tags": [], + "label": "loggingServiceMock", + "description": [], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "LoggingServiceSetup", + ">" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingServiceMock.createInternalPrebootContract", + "type": "Function", + "tags": [], + "label": "createInternalPrebootContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalLoggingServicePreboot", + ">" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingServiceMock.createInternalSetupContract", + "type": "Function", + "tags": [], + "label": "createInternalSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalLoggingServicePreboot", + ">" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock", + "type": "Object", + "tags": [], + "label": "loggingSystemMock", + "description": [], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked<", + "ILoggingSystem", + ">" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [], + "signature": [ + "(loggerFactory: ", + "LoggerFactory", + ") => { debug: [message: string, meta?: ", + "LogMeta", + " | undefined][]; error: [errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined][]; fatal: [errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined][]; info: [message: string, meta?: ", + "LogMeta", + " | undefined][]; log: [record: ", + "LogRecord", + "][]; trace: [message: string, meta?: ", + "LogMeta", + " | undefined][]; warn: [errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined][]; }" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.collect.$1", + "type": "Object", + "tags": [], + "label": "loggerFactory", + "description": [], + "signature": [ + "LoggerFactory" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [], + "signature": [ + "(loggerFactory: ", + "LoggerFactory", + ") => void" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.clear.$1", + "type": "Object", + "tags": [], + "label": "loggerFactory", + "description": [], + "signature": [ + "LoggerFactory" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.createLogger", + "type": "Function", + "tags": [], + "label": "createLogger", + "description": [], + "signature": [ + "(context?: string[] | undefined) => ", + "MockedLogger" + ], + "path": "packages/core/logging/core-logging-server-mocks/src/logging_system.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-logging-server-mocks", + "id": "def-server.loggingSystemMock.createLogger.$1", + "type": "Array", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__logging-mocks/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx new file mode 100644 index 0000000000000..535d4d3a932b5 --- /dev/null +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreLoggingServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks +title: "@kbn/core-logging-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-logging-server-mocks plugin +date: 2022-06-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreLoggingServerMocksObj from './kbn_core_logging_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 13 | 0 | 12 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 27e517a9eb85b..5f379191fe282 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 80e7aa5fb18b8..2162544a05f48 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 8a9d55345def6..95f2e776c80e5 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 6f1bb0dfd490a..c3811fd412a2e 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index ff971f7f17a66..f585bdc573c75 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index fb4757bfdeda4..e30cdaa95acac 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 32c25ec0a34c0..46fa0a53d918f 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 2e404f4f90d6e..1e5f7b4f3af51 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 1e18e178c60b1..a593ea5035957 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index a0e757b961abd..08ffcde971221 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 630d2d9bdcdae..4ff0302d119ec 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 21eb0c8e4a09c..63b6540345873 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 0d43b6ce69524..5380651f5a379 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 843f19ad00106..f7e83c49e3531 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 534a5c3d074e5..a060876ef8294 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 9f1670667c02a..f6dc380c6eb57 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 2869a23da1caa..2f6eb81c13c6e 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 9a334754f6e25..ae11aab2ae80e 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 6da70ba47f580..8330b2ec0d1ad 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 65f3571e01d53..7b06cbd48ba6a 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 97a5703265f3b..d57be8829be1c 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 4a4c6e156b968..c6aefbd3a2a73 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index e01413720f96a..f666a6a35d16d 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 90bce73503e11..748ca8964b47e 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 7a6e7a2150d91..116a3e5bfb5a3 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index f88beec0483e5..305bce79f7a17 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index cc2da152502e5..28f3452aa0801 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 2babb3818c770..ce97dea91ec10 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 49ddb2dd0123e..19a148f1b9a64 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 0fc6d5d92566d..70f66a8d84e60 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 82ebf993bc741..06e9bfecbf28b 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 7fe029225fd65..4d156a34493ca 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 1a9a87371c22d..f96db886af8ee 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index 7bca639f15929..1e8d2e041ad8c 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index b74dbc2d92963..21a881b8c9e94 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 3a672674f65fb..bca0097fd340c 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_scalability_simulation_generator.mdx b/api_docs/kbn_scalability_simulation_generator.mdx index d757c75bed9e9..99e0436572c4c 100644 --- a/api_docs/kbn_scalability_simulation_generator.mdx +++ b/api_docs/kbn_scalability_simulation_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-scalability-simulation-generator title: "@kbn/scalability-simulation-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/scalability-simulation-generator plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/scalability-simulation-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index f194f39a79b64..befdcbf244df1 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 64157f1a5879a..14e3623c1d2f1 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 17d13adb0243f..a5d22f2856471 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index d645d143b0114..b6dbcd138101b 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index a1dc982b9585f..9b722a3e50c54 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 70aa47217a41f..c28cef5e556ac 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index a7bb616edb57a..986209b3533f0 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 03b99c06674f2..c3df2a70c2ca5 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 4757db78f5d22..e7bc1ce950efa 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index f7a0e168ede3e..aaf737e4d5b00 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index eb9463c14ab62..d4ac078abbad4 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 8fc02370eb73f..c3075b99ee570 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 7c6a273a06627..629e39084edf0 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index ffc024d571746..37ec345bcef94 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 57e19cdde4411..e283d62175b26 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index c930a2eea34fc..42035384c3d57 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index ce7f727cf2c0a..bcc049c525f48 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index 52a296ad4bedd..480849798cd98 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index 3cfc74807e388..e47f5b9daf814 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 396a8c5374909..255b56f6a9dd8 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index fe9cc82d9e763..14cd49894a5e7 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 406cb27be4220..b405fd2cf9465 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 6b165f3deb40d..7decdcc305e7b 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index 655955b014ee7..7e5e5c6eceb3c 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index cec7a5b7e2bd1..3368a7ab9c159 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 96fdabd6a8c49..402b716b6cc1f 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 22ee4fc78462b..bd1a62e3435df 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 281cb53a0163b..5521938204a73 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index b998b81e39326..6f1b84a16cd16 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 76d58552b017a..d782de1dae9f6 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 1e74a3ad43bfb..b6014d1b8c0eb 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index 73fff26688083..df57d5d260f5f 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 6689af703250d..ae6037a1263f3 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index ed395b2dc7893..aa9b3fb0ea96f 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 265c2033e9729..797ab4c9112d8 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 4be371b7fe8a8..1a67afdbbd632 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types-jest plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index c325031caaae6..0f4d4f4b7174a 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index e40e26df82817..78ed43bbada8f 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 578d40ad72101..2242d950f6c29 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index b92cb11549ce3..fbd9b5bdd4acf 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 701af09b59c8e..bef023719b650 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github summary: API docs for the kubernetesSecurity plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index ae6ee08a0243d..1f41d750347a1 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index a78351084c110..0311a4144606e 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index 6d589dc2be840..64d2d74d65595 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 63cd961bf6aa1..90c723377b5b2 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index de1dda07bc6e0..374c61201b9aa 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 0dbc8cbb9ebfb..ec9cedc1b123d 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index b330d3baa5ae5..48aea2c4895dc 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 30c51ecb35576..9d4043ad6cc75 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index d39e1667dbced..1ea342d35e1de 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index d5f3c1a34705a..748bb78ac66d1 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index e3bc1a571cd2b..088a3a7cac1d3 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index bf656ce1928c0..207c3bb12cf30 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 87adddfbf7acb..8048f69d979dc 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index b19b9fb22783c..17c7f3d460722 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 21bf30d1d84e4..f7e4d6adb8263 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 5f5c5a1f4d211..32383fd0f8d8b 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 287 | 230 | 35 | +| 290 | 233 | 35 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 26541 | 172 | 19102 | 1242 | +| 26620 | 172 | 19141 | 1252 | ## Plugin Directory @@ -27,7 +27,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 241 | 0 | 236 | 19 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 23 | 0 | 19 | 1 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 11 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 359 | 0 | 350 | 20 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 363 | 0 | 354 | 20 | | | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 55 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 78 | 1 | 69 | 2 | @@ -38,12 +38,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2524 | 15 | 946 | 33 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2527 | 15 | 940 | 29 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3379 | 35 | 2525 | 21 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3372 | 35 | 2518 | 21 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 15 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | @@ -141,7 +141,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 436 | 1 | 332 | 35 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 388 | 0 | 374 | 34 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 389 | 0 | 375 | 35 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 130 | 0 | 91 | 11 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 205 | 0 | 142 | 9 | | | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 82 | 2 | 78 | 13 | @@ -204,6 +204,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 8 | 2 | 6 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 56 | 0 | 30 | 0 | +| | [Owner missing] | - | 9 | 0 | 5 | 1 | +| | [Owner missing] | - | 13 | 0 | 12 | 0 | | | [Owner missing] | - | 6 | 0 | 4 | 0 | | | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 428aea39f9a19..8d17c70635b98 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 53937a24e9b6b..a042b3740a67f 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 9dedf85aeee85..b1c829f78678e 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index b5f20c27512d0..d10a59bbd07d3 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 40931242a3bd2..33f15039f24ae 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 5c748a9dabfe7..89138bbe32a3b 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 42614109c93a0..a61a7eee2ca45 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 47af39a7b11ba..7b15727ad98e6 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 8645eef9f92e7..e4c11a2821387 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 4af9e977a3857..49c58d8bd77f3 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index b7a062fe9da8c..61d950b32adfa 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index db0ff186e2f0d..517de3434b0ad 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security.mdx b/api_docs/security.mdx index c36b96a3f2243..341da1ff265f2 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index ede3e3ea9dddb..c79b7d1ed0fc4 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index d80211dc276a1..c4ea5ee61f820 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 77259c9265a3f..85d7476dfa0f2 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index ae6f9ef9e103f..500e70f9d6fac 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index d5cd7c997e89c..72118a77eee39 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index f9eff9907ef0c..bf0983152c457 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 93c9350c6b770..183b1f1105347 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index a7bfa6cf50e08..1426b95f84d09 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index fbaa5ebf8ac88..495a173de69f4 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 57fb71e79634e..374f795aa17ff 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index a5b93f12daf42..be49b24529e5e 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 5a54d20a2fb23..21dea3bcd1f30 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 6de0c0a300e9f..44c529cd368f1 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index 8e45e8bffc28d..f0407efcf8d13 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index b57a0505d7df8..0b434e11ba237 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -1536,7 +1536,9 @@ "label": "snoozeRule", "description": [], "signature": [ - "({\n id,\n snoozeEndTime,\n http,\n}: { id: string; snoozeEndTime: string | -1; http: ", + "({\n id,\n snoozeSchedule,\n http,\n}: { id: string; snoozeSchedule: ", + "SnoozeSchedule", + "; http: ", { "pluginId": "core", "scope": "public", @@ -1554,7 +1556,7 @@ "id": "def-public.snoozeRule.$1", "type": "Object", "tags": [], - "label": "{\n id,\n snoozeEndTime,\n http,\n}", + "label": "{\n id,\n snoozeSchedule,\n http,\n}", "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", "deprecated": false, @@ -1571,13 +1573,13 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule.$1.snoozeEndTime", - "type": "CompoundType", + "id": "def-public.snoozeRule.$1.snoozeSchedule", + "type": "Object", "tags": [], - "label": "snoozeEndTime", + "label": "snoozeSchedule", "description": [], "signature": [ - "string | -1" + "SnoozeSchedule" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", "deprecated": false @@ -1758,7 +1760,7 @@ "label": "unsnoozeRule", "description": [], "signature": [ - "({ id, http }: { id: string; http: ", + "({\n id,\n http,\n scheduleIds,\n}: { id: string; http: ", { "pluginId": "core", "scope": "public", @@ -1766,7 +1768,7 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - "; }) => Promise" + "; scheduleIds?: string[] | undefined; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", "deprecated": false, @@ -1776,7 +1778,7 @@ "id": "def-public.unsnoozeRule.$1", "type": "Object", "tags": [], - "label": "{ id, http }", + "label": "{\n id,\n http,\n scheduleIds,\n}", "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", "deprecated": false, @@ -1809,6 +1811,19 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1.scheduleIds", + "type": "Array", + "tags": [], + "label": "scheduleIds", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false } ] } diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index a06696d3a1fb7..80428368d4eac 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,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 | 374 | 34 | +| 389 | 0 | 375 | 35 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index b38f001c99559..91add4fe3a647 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 12ec1f9d91d49..3c4dd685e0dfb 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 1a6140c152741..e8c89e1094e70 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 0402f9998ac50..4b52092837842 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 14279e05aa50f..c12a378c02365 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index 1ccbd1d0e2192..5e94564ea7785 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 400c2d5d334aa..dd3e748e4f8da 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index 6b55e7f068e9c..36ded170d7d2f 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 0b2024c1812b2..d410523075e93 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 6c539144c5bc8..e2e148842026b 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 2052df6e4c629..b38616526e102 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 4eb6a448fd2dd..eb93a2b5f1105 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index c52b9c2628ba2..42c8cd671ebe2 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index d94c8c83f7c68..c3f505b257520 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index fd1fe2fec5668..6adce6d305f4f 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 997add33f225e..daf06b80d1df9 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index b41cf3c71b12e..6012d5344f67b 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index c0669504f7365..f1fc3dd6e816f 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-06-20 +date: 2022-06-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/dev_docs/getting_started/development_windows.mdx b/dev_docs/getting_started/development_windows.mdx deleted file mode 100644 index 4300c307a7b11..0000000000000 --- a/dev_docs/getting_started/development_windows.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: kibDevTutorialSetupDevWindows -slug: /kibana-dev-docs/tutorial/setup-dev-windows -title: Development on Windows -summary: Learn how to setup a development environment on Windows -date: 2021-08-11 -tags: ['kibana', 'onboarding', 'dev', 'windows', 'setup'] ---- - - -# Overview - -Development on Windows is recommended through WSL2. WSL lets users run a Linux environment on Windows, providing a supported development environment for Kibana. - -## Install WSL - -The latest setup instructions can be found at https://docs.microsoft.com/en-us/windows/wsl/install-win10 - -1) Open Powershell as an administrator -1) Enable WSL - ``` - dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart - ``` -1) Enable Virtual Machine Platform - ``` - dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart - ``` -1) Download and install the [Linux kernel update package](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi) -1) Set WSL 2 as the default version - ``` - wsl --set-default-version 2 - ``` -1) Open the Micrsoft Store application and install a Linux distribution - -## Setup Kibana - -1. - -## Install VS Code - -Remote development is supported with an extension. [Reference](https://code.visualstudio.com/docs/remote/wsl). - -1) Install VS Code on Windows -1) Check the "Add to PATH" option during setup -1) Install the [Remote Development](https://aka.ms/vscode-remote/download/extension) package diff --git a/dev_docs/getting_started/setting_up_a_development_env.mdx b/dev_docs/getting_started/setting_up_a_development_env.mdx index 570dcb57a56b8..0cb0d109d1829 100644 --- a/dev_docs/getting_started/setting_up_a_development_env.mdx +++ b/dev_docs/getting_started/setting_up_a_development_env.mdx @@ -13,9 +13,11 @@ Setting up a development environment is pretty easy. In order to support Windows development we currently require you to use one of the following: - [Git Bash](https://git-scm.com/download/win) -- [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) +- [Windows Subsystem for Linux (recommended)](https://docs.microsoft.com/en-us/windows/wsl/about) -Before running the steps below, please make sure you have installed [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145) and that you are running all commands in either Git Bash or WSL. + If you want to know more about how to setup and use WSL for development on Windows, which will become our only supported way in the upcoming future, please check our . + + Before running the steps below, please make sure you have installed [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145) and that you are running all commands in either Git Bash or WSL. diff --git a/dev_docs/tutorials/development_windows.mdx b/dev_docs/tutorials/development_windows.mdx new file mode 100644 index 0000000000000..94f3e993219b7 --- /dev/null +++ b/dev_docs/tutorials/development_windows.mdx @@ -0,0 +1,163 @@ +--- +id: kibDevTutorialSetupWindowsDevWSL +slug: /kibana-dev-docs/tutorial/setup-windows-development-wsl +title: WSL on Windows Development +summary: Learn how to setup a Windows development environment using WSL +date: 2022-06-16 +tags: ['kibana', 'onboarding', 'setup', 'windows', 'development', 'wsl'] +--- + + +# Overview + +Development on Windows is recommended through WSL2. WSL lets users run a Linux environment on Windows, providing a supported development environment for Kibana. + + + + This guide allows you to achieve two different kind of experiences (Basic and Default each with their specifics). While we fully advise for upgrading into Windows 11 to use the much better Default experience (and will eventually remove the basic one from this guide), + for now both have a common prerequisite on enabling the hardware virtualization. + + Get that feature to work will highly depend on your hardware, as it should be enabled on your UEFI (or BIOS). Please check the official Microsoft documentation on + [How to Enable Virtualization on Windows](https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-11-pcs-c5578302-6e43-4b4b-a449-8ced115f58e1). + + After successfully achieve the previous step there is a second good guide describing [How to Enable Hyper-V Platform Feature on Windows](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v#enable-the-hyper-v-role-through-settings). + + Once hardware virtualization is enabled on Windows, please pay attention to the specific prerequisites for each type of experience listed below. + + ### Basic Experience + For a basic WSL usage you must be running **Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11**. Note that in a basic setup you won't be able to use + the browser GUI to visually run and/or debug functional tests. It's highly advisable to make sure you install the prerequisites for a default usage listed below. + + **Note:** For a normal development cycle we really advise to use the default experience setup within Windows 11. However if you have an explicit need for using a browser GUI + while using Windows 10, please follow each step of the guide below applicable for the Basic Experience setup and then check our . + + ### Default Experience + For a default experience and a completion of the entire guide which will make you able to run GUI apps you must be running **Windows 11 (Build 22000 and higher)**. + In addition to that, installing a **vGPU driver** is also required. Please choose the one compatible with your hardware: + + - [Intel GPU driver for WSL](https://www.intel.com/content/www/us/en/download/19344/intel-graphics-windows-dch-drivers.html?) + - [AMD GPU driver for WSL](https://www.amd.com/en/support/kb/release-notes/rn-rad-win-wsl-support) + - [NVIDIA GPU driver for WSL](https://developer.nvidia.com/cuda/wsl) (**Note:** NVIDIA does now includes the vGPU driver in their common gpu drivers. Please make sure you have your latest available drivers installed or refer to the previous link for official documentation) + + More information for that could be found in the [official guide for GUI apps on WSL](https://docs.microsoft.com/en-us/windows/wsl/tutorials/gui-apps#install-support-for-linux-gui-apps). + + +## Install WSL + +The latest setup instructions can be found at https://docs.microsoft.com/en-us/windows/wsl/install + +1. Open Powershell as an administrator + +2. Install WSL with Ubuntu and restart the machine when prompted + ``` + wsl --install -d Ubuntu + ``` + + In case you already have WSL installed you can just `wsl --update` and then reboot the machine. + +3. Once rebooted the installation will proceed for a new WSL install. If that's not the case make sure you're using + WSL2 and Ubuntu by + ``` + wsl --set-default-version 2 + ``` + + and + + ``` + wsl --set-default Ubuntu + ``` + +4. Install support for Google Chrome by running the following inside WSL shell **(IMPORTANT: )** + + Start by updating your apt package sources list with + ``` + sudo apt update + ``` + + Enter your user password, then + ``` + sudo apt -y upgrade && sudo apt -y autoremove + cd /tmp + wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb + sudo dpkg -i google-chrome-stable_current_amd64.deb + sudo apt install --fix-broken -y + sudo dpkg -i google-chrome-stable_current_amd64.deb + ``` + + Now you can launch Google Chrome by either `google-chrome` on your WSL shell or from Ubuntu Applications on Windows. + + It's also worth it to check if there are other useful [GUI packages you would want to add on WSL](https://docs.microsoft.com/en-us/windows/wsl/tutorials/gui-apps#update-the-packages-in-your-distribution) and then the configuration is complete. + +## Setup Kibana + +The next step is now for Kibana inside WSL just like in any other case. + +## Install VSCode + +Even though in previous steps you might have installed Nautilus and other X11 apps that allows you to use the file explorer for the WSL environment or even using some apps supported by X11 like +Sublime Text our recommended way to write your code is by using VSCode installed natively on Windows and then use its remote development extension to connect into the WSL environment. You can do this +by completing the following: + +1. Install VSCode on Windows +2. Check the "Add to PATH" option during setup +3. Install the [Remote Development](https://code.visualstudio.com/docs/remote/wsl) package + +For more information you can find the official documentation on how to Remote development is supported with an extension [here](https://code.visualstudio.com/docs/remote/wsl). + +## Success + +At this point you should be able to develop Kibana using WSL by writing code on VSCode, running commands for build, test and manage your dev environment using the WSL shell and finally having a basic GUI +support for your WSL environment using the applications we recommended like Google Chrome and others you choose to install like for example Nautilus file manager or other X11 based ones. + +## Short Term Workaround for Windows 10 GUI Support + +As mentioned before is highly recommended you setup your environment for a default experience using Windows 11. If you're reading this section is because you are not available to do that for a reason and +at the same time you still have the need for a GUI browser on Windows 10. Next you can find our recommendations for a short term workaround to achieve that for Windows 10 before we could terminate the support +for this operating system. + +1. Fulfil the as well as installing the . + +2. Make sure you've followed up to step 3, and . + +3. Install Google Chrome and it's dependencies by + ``` + cd /tmp + sudo apt-get update + sudo apt-get install -y curl unzip xvfb libxi6 libgconf-2-4 + wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb + sudo apt install ./google-chrome-stable_current_amd64.deb + ``` + + Then run `google-chrome --version` and you should be able to get the current version installed printed out. + +4. Download [VcXsrv](https://sourceforge.net/projects/vcxsrv) and install it natively on your **Windows**. Once installed go to the program files folder for VcXsrv and run `xlaunch.exe`. The majority of the default + settings are okay but make sure `Disable access control` is checked. In doubt, check the same settings as shown into this [Github issue image](https://github.com/microsoft/WSL/issues/4106#issuecomment-502920377). + Next, allow this application through the firewall if prompted when its first ran. Otherwise, if not asked, please go to `Windows firewall -> Allow an app through firewall -> click change settings -> select BOTH entries of "VcXsrv windows server" -> OK`. + +5. Configure the `DISPLAY` env var which in Linux tells GUI applications at which IP address the X Server is running. On WSL2 the IP for the native Windows is not localhost, so we need + to set DISPLAY to the correct IP address. Let's go ahead and add the following into the `.bashrc` file of your WSL environment: + ``` + export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2; exit;}'):0.0 + ``` + Once complete, running `echo $DISPLAY` inside your WSL shell should print the Windows native IP suffixed by `:0.0`. + +6. When reaching that point, if you run `google-chrome` on the WSL shell, the Chrome browser should open inside an X server window on Windows which should also work as expected when the functional tests chromedriver will try to use a browser to run into. + +### Troubleshooting the workaround + +#### Unable to open X display + +If that is seen when running the Google Chrome + +``` +Error: /etc/machine-id contains 0 characters (32 were expected). +Unable to open X display +``` + +- Make sure VcXsrv is running in Windows with “Disable access control” checked. +- Make sure VcXsrv is whitelisted in the Windows firewall (search the start menu for “Allow a program through Windows firewall” and enable it there) + +### More information + +For more information on how to configure this alternative X server or to troubleshoot other problems please check +the [official documentation](https://sourceforge.net/p/vcxsrv/wiki/VcXsrv%20%26%20Win10/) or a [popular Github issue](https://github.com/microsoft/WSL/issues/4106#issuecomment-502920377). diff --git a/docs/api/alerting.asciidoc b/docs/api/alerting.asciidoc index e0ea8cdc98509..fd5a23886cc5a 100644 --- a/docs/api/alerting.asciidoc +++ b/docs/api/alerting.asciidoc @@ -33,7 +33,7 @@ For deprecated APIs, refer to <>. include::alerting/create_rule.asciidoc[leveloffset=+1] include::alerting/delete_rule.asciidoc[leveloffset=+1] -include::alerting/update_rule.asciidoc[] +include::alerting/update_rule.asciidoc[leveloffset=+1] include::alerting/get_rules.asciidoc[] include::alerting/find_rules.asciidoc[] include::alerting/list_rule_types.asciidoc[] diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc index 484866436d97d..0b219ad00ebcb 100644 --- a/docs/api/alerting/create_rule.asciidoc +++ b/docs/api/alerting/create_rule.asciidoc @@ -207,7 +207,6 @@ The API returns the following: }, "rule_type_id": ".index-threshold", "scheduled_task_id": "425b0800-6bca-11eb-9e0d-85d233e3ee35", - "snooze_schedule":[], "created_by": "elastic", "updated_by": "elastic", "created_at": "2022-06-08T17:20:31.632Z", diff --git a/docs/api/alerting/update_rule.asciidoc b/docs/api/alerting/update_rule.asciidoc index 5fb8f17d6ebb5..ecce62912939d 100644 --- a/docs/api/alerting/update_rule.asciidoc +++ b/docs/api/alerting/update_rule.asciidoc @@ -1,5 +1,5 @@ [[update-rule-api]] -=== Update rule API +== Update rule API ++++ Update rule ++++ @@ -7,13 +7,22 @@ Update the attributes for an existing rule. [[update-rule-api-request]] -==== Request +=== {api-request-title} `PUT :/api/alerting/rule/` `PUT :/s//api/alerting/rule/` -==== {api-description-title} +=== {api-prereq-title} + +You must have `all` privileges for the *Management* > *Stack Rules* feature or +for the *{ml-app}*, *{observability}*, or *Security* features, depending on the +`consumer` and `rule_type_id` of the rule you're updating. If the rule has +`actions`, you must also have `read` privileges for the *Management* > +*Actions and Connectors* feature. For more details, refer to +<>. + +=== {api-description-title} [WARNING] ==== @@ -23,83 +32,109 @@ Update the attributes for an existing rule. Thereafter, when the rule performs queries, it uses those security privileges. If you have different privileges than the user that created or most recently updated the rule, you might change its behavior. +* Though some properties are optional, when you update the rule the existing +property values are overwritten with default values. Therefore, it is +recommended to explicitly set all property values. ==== [[update-rule-api-path-params]] -==== Path parameters +=== {api-path-parms-title} `id`:: - (Required, string) The ID of the rule that you want to update. +(Required, string) The ID of the rule that you want to update. `space_id`:: - (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. +(Optional, string) An identifier for the space. If `space_id` is not provided in +the URL, the default space is used. +[role="child_attributes"] [[update-rule-api-request-body]] -==== Request body - -`name`:: - (Required, string) A name to reference and search. - -`tags`:: - (Optional, string array) A list of keywords to reference and search. +=== {api-request-body-title} -`schedule`:: - (Required, object) When to run this rule. Use one of the available schedule formats. +`actions`:: +(Optional, object array) An array of action objects. The default value is an +empty array (`[]`). + -._Schedule Formats_. +.Properties of the action objects: [%collapsible%open] ===== -A schedule uses a key: value format. {kib} currently supports the _Interval format_ , which specifies the interval in seconds, minutes, hours, or days at which to execute the rule. +`group`::: +(Required, string) Grouping actions is recommended for escalations for different +types of alerts. If you don't need this, set the value to `default`. -Example: `{ interval: "10s" }`, `{ interval: "5m" }`, `{ interval: "1h" }`, `{ interval: "1d" }`. +`id`::: +(Required, string) The identifier of the action. +`params`::: +(Required, object) The map to the `params` that the +<> will receive. The `params` are handled as +Mustache templates and passed a default set of context. ===== -`throttle`:: - (Optional, string) How often this rule should fire the same actions. This will prevent the rule from sending out the same notification over and over. For example, if a rule with a `schedule` of 1 minute stays in a triggered state for 90 minutes, setting a `throttle` of `10m` or `1h` will prevent it from sending 90 notifications during this period. +`name`:: +(Required, string) A name to reference and search. `notify_when`:: - (Required, string) The condition for throttling the notification: `onActionGroupChange`, `onActiveAlert`, or `onThrottleInterval`. +(Required, string) The condition for throttling the notification: +`onActionGroupChange`, `onActiveAlert`, or `onThrottleInterval`. `params`:: - (Required, object) The parameters to pass to the rule type executor `params` value. This will also validate against the rule type params validator, if defined. +(Required, object) The parameters to pass to the rule type executor `params` +value. This will also validate against the rule type params validator, if defined. -`actions`:: - (Optional, object array) An array of the following action objects. +`schedule`:: +(Required, object) When to run this rule. Use one of the available schedule formats. + -.Properties of the action objects: +.Schedule formats [%collapsible%open] ===== - `group`::: - (Required, string) Grouping actions is recommended for escalations for different types of alerts. If you don't need this, set the value to `default`. - - `id`::: - (Required, string) The ID of the action that saved object executes. +A schedule uses a `key: value` format. {kib} currently supports the +_interval format_, which specifies the interval in seconds, minutes, hours, or +days at which to run the rule. For example: `{ "interval": "10s" }`, +`{ "interval": "5m" }`, `{ "interval": "1h" }`, or `{ "interval": "1d" }`. - `params`::: - (Required, object) The map to the `params` that the <> will receive. `params` are handled as Mustache templates and passed a default set of context. ===== +`tags`:: +(Optional, string array) A list of keywords to reference and search. The default +value is an empty array (`[]`). + +`throttle`:: +(Optional, string) How often this rule should fire the same actions. This will +prevent the rule from sending out the same notification over and over. For +example, if a rule with a `schedule` of 1 minute stays in a triggered state for +90 minutes, setting a `throttle` of `10m` or `1h` will prevent it from sending +90 notifications during this period. The default value is `null`. [[update-rule-api-response-codes]] -==== Response code +=== {api-response-codes-title} `200`:: - Indicates a successful call. +Indicates a successful call. [[update-rule-api-example]] -==== Example +=== {api-examples-title} -Update a rule with ID `ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74` with a different name: +Update an index threshold rule with ID `ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74`: [source,sh] -------------------------------------------------- -$ curl -X PUT api/alerting/rule/ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 - +PUT api/alerting/rule/ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 { "notify_when": "onActionGroupChange", "params": { - "aggType": "avg", + "index":[".test-index"], + "timeField":"@timestamp", + "groupBy":"top", + "aggType":"avg", + "timeWindowSize":5, + "timeWindowUnit":"m", + "thresholdComparator":">", + "threshold":[1000], + "aggType":"avg", + "aggField":"sheet.version", + "termField":"name.keyword", + "termSize":6 }, "schedule": { "interval": "1m" @@ -107,7 +142,7 @@ $ curl -X PUT api/alerting/rule/ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 "actions": [], "tags": [], "name": "new name", - "throttle": null, + "throttle": null } -------------------------------------------------- // KIBANA @@ -118,31 +153,42 @@ The API returns the following: -------------------------------------------------- { "id": "ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74", - "notify_when": "onActionGroupChange", - "params": { - "aggType": "avg", - }, "consumer": "alerts", - "rule_type_id": "test.rule.type", - "schedule": { - "interval": "1m" - }, - "actions": [], "tags": [], "name": "new name", "enabled": true, "throttle": null, + "schedule": { + "interval": "1m" + }, + "params": { + "index": [".updated-index"], + "timeField": "@timestamp", + "groupBy": "top", + "aggType": "avg", + "timeWindowSize": 5, + "timeWindowUnit": "m", + "thresholdComparator": ">", + "threshold": [1000], + "aggField": "sheet.version", + "termField": "name.keyword", + "termSize": 6 + }, "api_key_owner": "elastic", "created_by": "elastic", "updated_by": "elastic", + "rule_type_id": ".index-threshold", + "scheduled_task_id": "4c5eda00-e74f-11ec-b72f-5b18752ff9ea", + "created_at": "2022-06-08T17:20:31.632Z", + "updated_at": "2022-06-09T23:36:36.090Z", + "notify_when": "onActionGroupChange", "mute_all": false, "muted_alert_ids": [], - "updated_at": "2021-02-10T05:37:19.086Z", - "created_at": "2021-02-10T05:37:19.086Z", - "scheduled_task_id": "0b092d90-6b62-11eb-9e0d-85d233e3ee35", "execution_status": { - "last_execution_date": "2021-02-10T17:55:14.262Z", - "status": "ok" - } + "status": "ok", + "last_execution_date": "2022-06-09T23:36:17.332Z", + "last_duration": 577 + }, + "actions":[] } -------------------------------------------------- diff --git a/docs/development/core/public/index.md b/docs/development/core/public/index.md deleted file mode 100644 index 23c347fc16a7a..0000000000000 --- a/docs/development/core/public/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [kibana-plugin-core-public](./kibana-plugin-core-public.md) | The Kibana Core APIs for client-side plugins.A plugin's public/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.approute.md b/docs/development/core/public/kibana-plugin-core-public.app.approute.md deleted file mode 100644 index 357e6400c4e8c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.approute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [appRoute](./kibana-plugin-core-public.app.approute.md) - -## App.appRoute property - -Override the application's routing path from `/app/${id}`. Must be unique across registered applications. Should not include the base path from HTTP. - -Signature: - -```typescript -appRoute?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md deleted file mode 100644 index 4a027a6ab132c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [capabilities](./kibana-plugin-core-public.app.capabilities.md) - -## App.capabilities property - -Custom capabilities defined by the app. - -Signature: - -```typescript -capabilities?: Partial; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.category.md b/docs/development/core/public/kibana-plugin-core-public.app.category.md deleted file mode 100644 index a1e74f2bcf5e2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [category](./kibana-plugin-core-public.app.category.md) - -## App.category property - -The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference - -Signature: - -```typescript -category?: AppCategory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md b/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md deleted file mode 100644 index fe234cac08b68..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [chromeless](./kibana-plugin-core-public.app.chromeless.md) - -## App.chromeless property - -Hide the UI chrome when the application is mounted. Defaults to `false`. Takes precedence over chrome service visibility settings. - -Signature: - -```typescript -chromeless?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md b/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md deleted file mode 100644 index d9f76fb38a55d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [deepLinks](./kibana-plugin-core-public.app.deeplinks.md) - -## App.deepLinks property - -Input type for registering secondary in-app locations for an application. - -Deep links must include at least one of `path` or `deepLinks`. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. - -Signature: - -```typescript -deepLinks?: AppDeepLink[]; -``` - -## Example - - -```ts -core.application.register({ - id: 'my_app', - title: 'Translated title', - keywords: ['translated keyword1', 'translated keyword2'], - deepLinks: [ - { - id: 'sub1', - title: 'Sub1', - path: '/sub1', - keywords: ['subpath1'], - }, - { - id: 'sub2', - title: 'Sub2', - deepLinks: [ - { - id: 'subsub', - title: 'SubSub', - path: '/sub2/sub', - keywords: ['subpath2'], - }, - ], - }, - ], - mount: () => { ... } -}) -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md b/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md deleted file mode 100644 index 3c952ec053e62..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [defaultPath](./kibana-plugin-core-public.app.defaultpath.md) - -## App.defaultPath property - -Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the `path` option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. - -Signature: - -```typescript -defaultPath?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md b/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md deleted file mode 100644 index 71f6352ec006c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [exactRoute](./kibana-plugin-core-public.app.exactroute.md) - -## App.exactRoute property - -If set to true, the application's route will only be checked against an exact match. Defaults to `false`. - -Signature: - -```typescript -exactRoute?: boolean; -``` - -## Example - - -```ts -core.application.register({ - id: 'my_app', - title: 'My App', - exactRoute: true, - mount: () => { ... }, -}) - -// '[basePath]/app/my_app' will be matched -// '[basePath]/app/my_app/some/path' will not be matched -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.id.md b/docs/development/core/public/kibana-plugin-core-public.app.id.md deleted file mode 100644 index 39f6e62dae04c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [id](./kibana-plugin-core-public.app.id.md) - -## App.id property - -The unique identifier of the application. - -Can only be composed of alphanumeric characters, `-`, `:` and `_` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.keywords.md b/docs/development/core/public/kibana-plugin-core-public.app.keywords.md deleted file mode 100644 index 585df1b48c16e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.keywords.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [keywords](./kibana-plugin-core-public.app.keywords.md) - -## App.keywords property - -Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. - -Signature: - -```typescript -keywords?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.md b/docs/development/core/public/kibana-plugin-core-public.app.md deleted file mode 100644 index 71bf216f30250..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) - -## App interface - - -Signature: - -```typescript -export interface App extends AppNavOptions -``` -Extends: AppNavOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appRoute?](./kibana-plugin-core-public.app.approute.md) | string | (Optional) Override the application's routing path from /app/${id}. Must be unique across registered applications. Should not include the base path from HTTP. | -| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | Partial<Capabilities> | (Optional) Custom capabilities defined by the app. | -| [category?](./kibana-plugin-core-public.app.category.md) | AppCategory | (Optional) The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference | -| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | boolean | (Optional) Hide the UI chrome when the application is mounted. Defaults to false. Takes precedence over chrome service visibility settings. | -| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | AppDeepLink\[\] | (Optional) Input type for registering secondary in-app locations for an application.Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | -| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | string | (Optional) Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the path option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. | -| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | boolean | (Optional) If set to true, the application's route will only be checked against an exact match. Defaults to false. | -| [id](./kibana-plugin-core-public.app.id.md) | string | The unique identifier of the application.Can only be composed of alphanumeric characters, -, : and _ | -| [keywords?](./kibana-plugin-core-public.app.keywords.md) | string\[\] | (Optional) Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. | -| [mount](./kibana-plugin-core-public.app.mount.md) | AppMount<HistoryLocationState> | A mount function called when the user navigates to this app's route. | -| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | AppNavLinkStatus | (Optional) The initial status of the application's navLink. Defaulting to visible if status is accessible and hidden if status is inaccessible See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) | -| [searchable?](./kibana-plugin-core-public.app.searchable.md) | boolean | (Optional) The initial flag to determine if the application is searchable in the global search. Defaulting to true if navLinkStatus is visible or omitted. | -| [status?](./kibana-plugin-core-public.app.status.md) | AppStatus | (Optional) The initial status of the application. Defaulting to accessible | -| [title](./kibana-plugin-core-public.app.title.md) | string | The title of the application. | -| [updater$?](./kibana-plugin-core-public.app.updater_.md) | Observable<AppUpdater> | (Optional) An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.mount.md b/docs/development/core/public/kibana-plugin-core-public.app.mount.md deleted file mode 100644 index 460ded2a4bff1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.mount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [mount](./kibana-plugin-core-public.app.mount.md) - -## App.mount property - -A mount function called when the user navigates to this app's route. - -Signature: - -```typescript -mount: AppMount; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md b/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md deleted file mode 100644 index c01a26e42e237..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md) - -## App.navLinkStatus property - -The initial status of the application's navLink. Defaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible` See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) - -Signature: - -```typescript -navLinkStatus?: AppNavLinkStatus; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.searchable.md b/docs/development/core/public/kibana-plugin-core-public.app.searchable.md deleted file mode 100644 index ab1b559a7f6a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.searchable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [searchable](./kibana-plugin-core-public.app.searchable.md) - -## App.searchable property - -The initial flag to determine if the application is searchable in the global search. Defaulting to `true` if `navLinkStatus` is `visible` or omitted. - -Signature: - -```typescript -searchable?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.status.md b/docs/development/core/public/kibana-plugin-core-public.app.status.md deleted file mode 100644 index caa6ff1dcac9e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.status.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [status](./kibana-plugin-core-public.app.status.md) - -## App.status property - -The initial status of the application. Defaulting to `accessible` - -Signature: - -```typescript -status?: AppStatus; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.title.md b/docs/development/core/public/kibana-plugin-core-public.app.title.md deleted file mode 100644 index c705e3ab8d2b1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [title](./kibana-plugin-core-public.app.title.md) - -## App.title property - -The title of the application. - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.updater_.md b/docs/development/core/public/kibana-plugin-core-public.app.updater_.md deleted file mode 100644 index e6789a38f12f7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.updater_.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [updater$](./kibana-plugin-core-public.app.updater_.md) - -## App.updater$ property - -An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. - -Signature: - -```typescript -updater$?: Observable; -``` - -## Example - -How to update an application navLink at runtime - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - private appUpdater = new BehaviorSubject(() => ({})); - - setup({ application }) { - application.register({ - id: 'my-app', - title: 'My App', - updater$: this.appUpdater, - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } - - start() { - // later, when the navlink needs to be updated - appUpdater.next(() => { - navLinkStatus: AppNavLinkStatus.disabled, - }) - } -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md b/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md deleted file mode 100644 index 577c7edbeef4a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [APP\_WRAPPER\_CLASS](./kibana-plugin-core-public.app_wrapper_class.md) - -## APP\_WRAPPER\_CLASS variable - -The class name for top level \*and\* nested application wrappers to ensure proper layout - -Signature: - -```typescript -APP_WRAPPER_CLASS = "kbnAppWrapper" -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md deleted file mode 100644 index ff805bd94174a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [ariaLabel](./kibana-plugin-core-public.appcategory.arialabel.md) - -## AppCategory.ariaLabel property - -If the visual label isn't appropriate for screen readers, can override it here - -Signature: - -```typescript -ariaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md deleted file mode 100644 index 578f70224342b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [euiIconType](./kibana-plugin-core-public.appcategory.euiicontype.md) - -## AppCategory.euiIconType property - -Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md deleted file mode 100644 index 0342a1d9ee95b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [id](./kibana-plugin-core-public.appcategory.id.md) - -## AppCategory.id property - -Unique identifier for the categories - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md deleted file mode 100644 index 02c000e88f31d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [label](./kibana-plugin-core-public.appcategory.label.md) - -## AppCategory.label property - -Label used for category name. Also used as aria-label if one isn't set. - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.md deleted file mode 100644 index 40c714b51b8bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) - -## AppCategory interface - -A category definition for nav links to know where to sort them in the left hand nav - -Signature: - -```typescript -export interface AppCategory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ariaLabel?](./kibana-plugin-core-public.appcategory.arialabel.md) | string | (Optional) If the visual label isn't appropriate for screen readers, can override it here | -| [euiIconType?](./kibana-plugin-core-public.appcategory.euiicontype.md) | string | (Optional) Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined | -| [id](./kibana-plugin-core-public.appcategory.id.md) | string | Unique identifier for the categories | -| [label](./kibana-plugin-core-public.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. | -| [order?](./kibana-plugin-core-public.appcategory.order.md) | number | (Optional) The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md deleted file mode 100644 index 76959c060fa8b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [order](./kibana-plugin-core-public.appcategory.order.md) - -## AppCategory.order property - -The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md b/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md deleted file mode 100644 index 30fd3085a4341..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) - -## AppDeepLink type - -Input type for registering secondary in-app locations for an application. - -Deep links must include at least one of `path` or `deepLinks`. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. - -Signature: - -```typescript -export declare type AppDeepLink = { - id: string; - title: string; - keywords?: string[]; - navLinkStatus?: AppNavLinkStatus; - searchable?: boolean; -} & AppNavOptions & ({ - path: string; - deepLinks?: AppDeepLink[]; -} | { - path?: string; - deepLinks: AppDeepLink[]; -}); -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md b/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md deleted file mode 100644 index 48323ebaf8e77..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) - -## AppLeaveAction type - -Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) - -See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) - -Signature: - -```typescript -export declare type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md b/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md deleted file mode 100644 index 9df408c885a18..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveActionType](./kibana-plugin-core-public.appleaveactiontype.md) - -## AppLeaveActionType enum - -Possible type of actions on application leave. - -Signature: - -```typescript -export declare enum AppLeaveActionType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| confirm | "confirm" | | -| default | "default" | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md deleted file mode 100644 index 6a3c790cd17a2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [buttonColor](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md) - -## AppLeaveConfirmAction.buttonColor property - -Signature: - -```typescript -buttonColor?: ButtonColor; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md deleted file mode 100644 index 8ebc9068aa612..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [callback](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) - -## AppLeaveConfirmAction.callback property - -Signature: - -```typescript -callback?: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md deleted file mode 100644 index 10ccb6d220f3f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [confirmButtonText](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md) - -## AppLeaveConfirmAction.confirmButtonText property - -Signature: - -```typescript -confirmButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md deleted file mode 100644 index 9f18643787019..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) - -## AppLeaveConfirmAction interface - -Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application. - -See - -Signature: - -```typescript -export interface AppLeaveConfirmAction -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [buttonColor?](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md) | ButtonColor | (Optional) | -| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | () => void | (Optional) | -| [confirmButtonText?](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md) | string | (Optional) | -| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | string | | -| [title?](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | string | (Optional) | -| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | AppLeaveActionType.confirm | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md deleted file mode 100644 index 9caea99fd4a07..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) - -## AppLeaveConfirmAction.text property - -Signature: - -```typescript -text: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md deleted file mode 100644 index cda43267e3311..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [title](./kibana-plugin-core-public.appleaveconfirmaction.title.md) - -## AppLeaveConfirmAction.title property - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md deleted file mode 100644 index fdff75caedc58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) - -## AppLeaveConfirmAction.type property - -Signature: - -```typescript -type: AppLeaveActionType.confirm; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md b/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md deleted file mode 100644 index 5d0e0d2a216e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) - -## AppLeaveDefaultAction interface - -Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application. - -See - -Signature: - -```typescript -export interface AppLeaveDefaultAction -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | AppLeaveActionType.default | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md b/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md deleted file mode 100644 index c6bac03c4e002..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) > [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) - -## AppLeaveDefaultAction.type property - -Signature: - -```typescript -type: AppLeaveActionType.default; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md b/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md deleted file mode 100644 index 256ea00e7ef7b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) - -## AppLeaveHandler type - -> Warning: This API is now obsolete. -> -> [AppMountParameters.onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) has been deprecated in favor of [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) 8.8.0 -> - -A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return `confirm` to prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing). - -See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. - -Signature: - -```typescript -export declare type AppLeaveHandler = (factory: AppLeaveActionFactory, nextAppId?: string) => AppLeaveAction; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md deleted file mode 100644 index 2e8702a56f309..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -## ApplicationSetup interface - - -Signature: - -```typescript -export interface ApplicationSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [register(app)](./kibana-plugin-core-public.applicationsetup.register.md) | Register an mountable application to the system. | -| [registerAppUpdater(appUpdater$)](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) | Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) fields of all applications at runtime.This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the updater$ property of the registered application instead. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md deleted file mode 100644 index e53b28e88d6ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [register](./kibana-plugin-core-public.applicationsetup.register.md) - -## ApplicationSetup.register() method - -Register an mountable application to the system. - -Signature: - -```typescript -register(app: App): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| app | App<HistoryLocationState> | an [App](./kibana-plugin-core-public.app.md) | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md deleted file mode 100644 index 6e8203fd68197..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [registerAppUpdater](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) - -## ApplicationSetup.registerAppUpdater() method - -Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) fields of all applications at runtime. - -This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the `updater$` property of the registered application instead. - -Signature: - -```typescript -registerAppUpdater(appUpdater$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appUpdater$ | Observable<AppUpdater> | | - -Returns: - -void - -## Example - -How to register an application updater that disables some applications: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.registerAppUpdater( - new BehaviorSubject(app => { - if (myPluginApi.shouldDisable(app)) - return { - status: AppStatus.inaccessible, - }; - }) - ); - } -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md deleted file mode 100644 index bcc5435f35951..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) - -## ApplicationStart.applications$ property - -Observable emitting the list of currently registered apps and their associated status. - -Signature: - -```typescript -applications$: Observable>; -``` - -## Remarks - -Applications disabled by [Capabilities](./kibana-plugin-core-public.capabilities.md) will not be present in the map. Applications manually disabled from the client-side using an [application updater](./kibana-plugin-core-public.appupdater.md) are present, with their status properly set as `inaccessible`. - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md deleted file mode 100644 index 3d9353a246888..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) - -## ApplicationStart.capabilities property - -Gets the read-only capabilities. - -Signature: - -```typescript -capabilities: RecursiveReadonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md deleted file mode 100644 index 1c1e118b8bfac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) - -## ApplicationStart.currentAppId$ property - -An observable that emits the current application id and each subsequent id update. - -Signature: - -```typescript -currentAppId$: Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md deleted file mode 100644 index 8bc89f617e157..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [getUrlForApp](./kibana-plugin-core-public.applicationstart.geturlforapp.md) - -## ApplicationStart.getUrlForApp() method - -Returns the absolute path (or URL) to a given app, including the global base path. - -By default, it returns the absolute path of the application (e.g `/basePath/app/my-app`). Use the `absolute` option to generate an absolute url instead (e.g `http://host:port/basePath/app/my-app`) - -Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. - -Signature: - -```typescript -getUrlForApp(appId: string, options?: { - path?: string; - absolute?: boolean; - deepLinkId?: string; - }): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appId | string | | -| options | { path?: string; absolute?: boolean; deepLinkId?: string; } | | - -Returns: - -string - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.md deleted file mode 100644 index 62128b840fb78..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) - -## ApplicationStart interface - - -Signature: - -```typescript -export interface ApplicationStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) | Observable<ReadonlyMap<string, PublicAppInfo>> | Observable emitting the list of currently registered apps and their associated status. | -| [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) | RecursiveReadonly<Capabilities> | Gets the read-only capabilities. | -| [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) | Observable<string \| undefined> | An observable that emits the current application id and each subsequent id update. | - -## Methods - -| Method | Description | -| --- | --- | -| [getUrlForApp(appId, options)](./kibana-plugin-core-public.applicationstart.geturlforapp.md) | Returns the absolute path (or URL) to a given app, including the global base path.By default, it returns the absolute path of the application (e.g /basePath/app/my-app). Use the absolute option to generate an absolute url instead (e.g http://host:port/basePath/app/my-app)Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. | -| [navigateToApp(appId, options)](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | Navigate to a given app | -| [navigateToUrl(url, options)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).The method resolves pathnames the same way browsers do when resolving a <a href> value. The provided url can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app// or any application's appRoute configuration)Then a SPA navigation will be performed using navigateToApp using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using window.location.assign. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md deleted file mode 100644 index a6f87209148fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) - -## ApplicationStart.navigateToApp() method - -Navigate to a given app - -Signature: - -```typescript -navigateToApp(appId: string, options?: NavigateToAppOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appId | string | | -| options | NavigateToAppOptions | navigation options | - -Returns: - -Promise<void> - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md deleted file mode 100644 index b6093340cfbf3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md +++ /dev/null @@ -1,50 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToUrl](./kibana-plugin-core-public.applicationstart.navigatetourl.md) - -## ApplicationStart.navigateToUrl() method - -Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath). - -The method resolves pathnames the same way browsers do when resolving a `` value. The provided `url` can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href) - -If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app// or any application's `appRoute` configuration) - -Then a SPA navigation will be performed using `navigateToApp` using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using `window.location.assign`. - -Signature: - -```typescript -navigateToUrl(url: string, options?: NavigateToUrlOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | an absolute URL, an absolute path or a relative path, to navigate to. | -| options | NavigateToUrlOptions | navigation options | - -Returns: - -Promise<void> - -## Example - - -```ts -// current url: `https://kibana:8080/base-path/s/my-space/app/dashboard` - -// will call `application.navigateToApp('discover', { path: '/some-path?foo=bar'})` -application.navigateToUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar') -application.navigateToUrl('/base-path/s/my-space/app/discover/some-path?foo=bar') -application.navigateToUrl('./discover/some-path?foo=bar') - -// will perform a full page reload using `window.location.assign` -application.navigateToUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match -application.navigateToUrl('/app/discover/some-path') // does not include the current basePath -application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application -application.navigateToUrl('../discover') // resolve to `/base-path/s/my-space/discover` which is not a path of a known app. -application.navigateToUrl('../../other-space/discover') // resolve to `/base-path/s/other-space/discover` which is not within the current basePath. -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmount.md b/docs/development/core/public/kibana-plugin-core-public.appmount.md deleted file mode 100644 index 0b02b7df597ae..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMount](./kibana-plugin-core-public.appmount.md) - -## AppMount type - -A mount function called when the user navigates to this app's route. - -Signature: - -```typescript -export declare type AppMount = (params: AppMountParameters) => AppUnmount | Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md deleted file mode 100644 index 09a96cb3ce57a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) - -## AppMountParameters.appBasePath property - -> Warning: This API is now obsolete. -> -> Use [AppMountParameters.history](./kibana-plugin-core-public.appmountparameters.history.md) instead. 8.8.0 -> - -The route path for configuring navigation to the application. This string should not include the base path from HTTP. - -Signature: - -```typescript -appBasePath: string; -``` - -## Example - -How to configure react-router with a base path: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.register({ - id: 'my-app', - appRoute: '/my-app', - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } -} -``` - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ appBasePath, element }: AppMountParameters) => { - ReactDOM.render( - // pass `appBasePath` to `basename` - - - , - element - ); - - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md deleted file mode 100644 index 4d8c2a8644ad9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [element](./kibana-plugin-core-public.appmountparameters.element.md) - -## AppMountParameters.element property - -The container element to render the application into. - -Signature: - -```typescript -element: HTMLElement; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md deleted file mode 100644 index c22267eadbe28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [history](./kibana-plugin-core-public.appmountparameters.history.md) - -## AppMountParameters.history property - -A scoped history instance for your application. Should be used to wire up your applications Router. - -Signature: - -```typescript -history: ScopedHistory; -``` - -## Example - -How to configure react-router with a base path: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.register({ - id: 'my-app', - appRoute: '/my-app', - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } -} -``` - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { Router, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history }: AppMountParameters) => { - ReactDOM.render( - - - , - element - ); - - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md deleted file mode 100644 index 357998ecaea26..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) - -## AppMountParameters interface - - -Signature: - -```typescript -export interface AppMountParameters -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | string | The route path for configuring navigation to the application. This string should not include the base path from HTTP. | -| [element](./kibana-plugin-core-public.appmountparameters.element.md) | HTMLElement | The container element to render the application into. | -| [history](./kibana-plugin-core-public.appmountparameters.history.md) | ScopedHistory<HistoryLocationState> | A scoped history instance for your application. Should be used to wire up your applications Router. | -| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | (handler: AppLeaveHandler) => void | A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page.This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. | -| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | (menuMount: MountPoint \| undefined) => void | A function that can be used to set the mount point used to populate the application action container in the chrome header.Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with undefined will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. | -| [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md) | Observable<CoreTheme> | An observable emitting . Should be used when mounting the application to include theme information. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md deleted file mode 100644 index 67c6d63175591..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) - -## AppMountParameters.onAppLeave property - -> Warning: This API is now obsolete. -> -> [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) should be used instead. 8.8.0 -> - -A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page. - -This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. - -Signature: - -```typescript -onAppLeave: (handler: AppLeaveHandler) => void; -``` - -## Example - - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history, onAppLeave }: AppMountParameters) => { - const { renderApp, hasUnsavedChanges } = await import('./application'); - onAppLeave(actions => { - if(hasUnsavedChanges()) { - return actions.confirm('Some changes were not saved. Are you sure you want to leave?'); - } - return actions.default(); - }); - return renderApp({ element, history }); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md deleted file mode 100644 index 715e1ba4bf291..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) - -## AppMountParameters.setHeaderActionMenu property - -A function that can be used to set the mount point used to populate the application action container in the chrome header. - -Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with `undefined` will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. - -Signature: - -```typescript -setHeaderActionMenu: (menuMount: MountPoint | undefined) => void; -``` - -## Example - - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history, setHeaderActionMenu }: AppMountParameters) => { - const { renderApp } = await import('./application'); - const { renderActionMenu } = await import('./action_menu'); - setHeaderActionMenu((element) => { - return renderActionMenu(element); - }) - return renderApp({ element, history }); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md deleted file mode 100644 index 7c69f76237361..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md) - -## AppMountParameters.theme$ property - -An observable emitting . Should be used when mounting the application to include theme information. - -Signature: - -```typescript -theme$: Observable; -``` - -## Example - -When mounting a react application: - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; - -import { AppMountParameters } from 'src/core/public'; -import { wrapWithTheme } from 'src/plugins/kibana_react'; -import { MyApp } from './app'; - -export renderApp = ({ element, theme$ }: AppMountParameters) => { - ReactDOM.render(wrapWithTheme(, theme$), element); - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md b/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md deleted file mode 100644 index 979816249d5cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) - -## AppNavLinkStatus enum - -Status of the application's navLink. - -Signature: - -```typescript -export declare enum AppNavLinkStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| default | 0 | The application navLink will be visible if the application's [AppStatus](./kibana-plugin-core-public.appstatus.md) is set to accessible and hidden if the application status is set to inaccessible. | -| disabled | 2 | The application navLink is visible but inactive and not clickable in the navigation bar. | -| hidden | 3 | The application navLink does not appear in the navigation bar. | -| visible | 1 | The application navLink is visible and clickable in the navigation bar. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md deleted file mode 100644 index ed9d07cd29861..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [euiIconType](./kibana-plugin-core-public.appnavoptions.euiicontype.md) - -## AppNavOptions.euiIconType property - -A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property. - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md deleted file mode 100644 index 3b809fc4aec39..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [icon](./kibana-plugin-core-public.appnavoptions.icon.md) - -## AppNavOptions.icon property - -A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided. - -Signature: - -```typescript -icon?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md deleted file mode 100644 index c6c583b7a9098..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) - -## AppNavOptions interface - -App navigation menu options - -Signature: - -```typescript -export interface AppNavOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [euiIconType?](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | string | (Optional) A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. | -| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. | -| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. | -| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | string | (Optional) A tooltip shown when hovering over app link. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md deleted file mode 100644 index ca7ae482a04ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [order](./kibana-plugin-core-public.appnavoptions.order.md) - -## AppNavOptions.order property - -An ordinal used to sort nav links relative to one another for display. - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md deleted file mode 100644 index 97c18c2e56a1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [tooltip](./kibana-plugin-core-public.appnavoptions.tooltip.md) - -## AppNavOptions.tooltip property - -A tooltip shown when hovering over app link. - -Signature: - -```typescript -tooltip?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appstatus.md b/docs/development/core/public/kibana-plugin-core-public.appstatus.md deleted file mode 100644 index 438d6d7d4728b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appstatus.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppStatus](./kibana-plugin-core-public.appstatus.md) - -## AppStatus enum - -Accessibility status of an application. - -Signature: - -```typescript -export declare enum AppStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| accessible | 0 | Application is accessible. | -| inaccessible | 1 | Application is not accessible. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appunmount.md b/docs/development/core/public/kibana-plugin-core-public.appunmount.md deleted file mode 100644 index 1c066f67a8ffe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appunmount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUnmount](./kibana-plugin-core-public.appunmount.md) - -## AppUnmount type - -A function called when an application should be unmounted from the page. This function should be synchronous. - -Signature: - -```typescript -export declare type AppUnmount = () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md b/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md deleted file mode 100644 index c24da05abe7ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) - -## AppUpdatableFields type - -Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md). - -Signature: - -```typescript -export declare type AppUpdatableFields = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appupdater.md b/docs/development/core/public/kibana-plugin-core-public.appupdater.md deleted file mode 100644 index 744c52f221da7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appupdater.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdater](./kibana-plugin-core-public.appupdater.md) - -## AppUpdater type - -Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -Signature: - -```typescript -export declare type AppUpdater = (app: App) => Partial | undefined; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md deleted file mode 100644 index f31b1b3333175..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) - -## Capabilities.catalogue property - -Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. - -Signature: - -```typescript -catalogue: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md deleted file mode 100644 index c1f06e692d638..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [management](./kibana-plugin-core-public.capabilities.management.md) - -## Capabilities.management property - -Management section capabilities. - -Signature: - -```typescript -management: { - [sectionId: string]: Record; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.md deleted file mode 100644 index e908bd554d88d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) - -## Capabilities interface - -The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. - -Signature: - -```typescript -export interface Capabilities -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) | Record<string, boolean> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. | -| [management](./kibana-plugin-core-public.capabilities.management.md) | { \[sectionId: string\]: Record<string, boolean>; } | Management section capabilities. | -| [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) | Record<string, boolean> | Navigation link capabilities. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md deleted file mode 100644 index 5f4016ba5a308..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) - -## Capabilities.navLinks property - -Navigation link capabilities. - -Signature: - -```typescript -navLinks: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md deleted file mode 100644 index 28244a2c9d8c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [iconType](./kibana-plugin-core-public.chromebadge.icontype.md) - -## ChromeBadge.iconType property - -Signature: - -```typescript -iconType?: IconType; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.md deleted file mode 100644 index e2e4d1910fdd5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) - -## ChromeBadge interface - - -Signature: - -```typescript -export interface ChromeBadge -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [iconType?](./kibana-plugin-core-public.chromebadge.icontype.md) | IconType | (Optional) | -| [text](./kibana-plugin-core-public.chromebadge.text.md) | string | | -| [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md deleted file mode 100644 index b2b4e415c24c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [text](./kibana-plugin-core-public.chromebadge.text.md) - -## ChromeBadge.text property - -Signature: - -```typescript -text: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md deleted file mode 100644 index fa22d739e86ee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) - -## ChromeBadge.tooltip property - -Signature: - -```typescript -tooltip: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md b/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md deleted file mode 100644 index f88e855d436ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md) - -## ChromeBreadcrumb type - - -Signature: - -```typescript -export declare type ChromeBreadcrumb = EuiBreadcrumb; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md deleted file mode 100644 index cf31d16cae0e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [change](./kibana-plugin-core-public.chromedoctitle.change.md) - -## ChromeDocTitle.change() method - -Changes the current document title. - -Signature: - -```typescript -change(newTitle: string | string[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newTitle | string \| string\[\] | The new title to set, either a string or string array | - -Returns: - -void - -## Example - -How to change the title of the document - -```ts -chrome.docTitle.change('My application title') -chrome.docTitle.change(['My application', 'My section']) -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md deleted file mode 100644 index 48e04b648e8d8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) - -## ChromeDocTitle interface - -APIs for accessing and updating the document title. - -Signature: - -```typescript -export interface ChromeDocTitle -``` - -## Example 1 - -How to change the title of the document - -```ts -chrome.docTitle.change('My application') -``` - -## Example 2 - -How to reset the title of the document to it's initial value - -```ts -chrome.docTitle.reset() -``` - -## Methods - -| Method | Description | -| --- | --- | -| [change(newTitle)](./kibana-plugin-core-public.chromedoctitle.change.md) | Changes the current document title. | -| [reset()](./kibana-plugin-core-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md deleted file mode 100644 index e11635fd6d3f8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [reset](./kibana-plugin-core-public.chromedoctitle.reset.md) - -## ChromeDocTitle.reset() method - -Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) - -Signature: - -```typescript -reset(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md deleted file mode 100644 index 2ac957095c666..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) - -## ChromeHelpExtension.appName property - -Provide your plugin's name to create a header for separation - -Signature: - -```typescript -appName: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md deleted file mode 100644 index 68e05949e9b1b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [content](./kibana-plugin-core-public.chromehelpextension.content.md) - -## ChromeHelpExtension.content property - -Custom content to occur below the list of links - -Signature: - -```typescript -content?: (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md deleted file mode 100644 index 41a6b638a3360..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [links](./kibana-plugin-core-public.chromehelpextension.links.md) - -## ChromeHelpExtension.links property - -Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button - -Signature: - -```typescript -links?: ChromeHelpExtensionMenuLink[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md deleted file mode 100644 index 0c038f81edc90..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) - -## ChromeHelpExtension interface - - -Signature: - -```typescript -export interface ChromeHelpExtension -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) | string | Provide your plugin's name to create a header for separation | -| [content?](./kibana-plugin-core-public.chromehelpextension.content.md) | (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void | (Optional) Custom content to occur below the list of links | -| [links?](./kibana-plugin-core-public.chromehelpextension.links.md) | ChromeHelpExtensionMenuLink\[\] | (Optional) Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md deleted file mode 100644 index 1faef45c0b2b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) - -## ChromeHelpExtensionLinkBase type - - -Signature: - -```typescript -export declare type ChromeHelpExtensionLinkBase = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md deleted file mode 100644 index dc455ca43d24a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) - -## ChromeHelpExtensionMenuCustomLink.content property - -Content of the button (in lieu of `children`) - -Signature: - -```typescript -content: React.ReactNode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md deleted file mode 100644 index feb91acd6d915..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) - -## ChromeHelpExtensionMenuCustomLink.href property - -URL of the link - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md deleted file mode 100644 index a02b219754042..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) - -## ChromeHelpExtensionMenuCustomLink.linkType property - -Extend EuiButtonEmpty to provide extra functionality - -Signature: - -```typescript -linkType: 'custom'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md deleted file mode 100644 index daf724c72c23e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) - -## ChromeHelpExtensionMenuCustomLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuCustomLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | React.ReactNode | Content of the button (in lieu of children) | -| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | string | URL of the link | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | 'custom' | Extend EuiButtonEmpty to provide extra functionality | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md deleted file mode 100644 index b6714c39a4699..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) - -## ChromeHelpExtensionMenuDiscussLink.href property - -URL to discuss page. i.e. `https://discuss.elastic.co/c/${appName}` - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md deleted file mode 100644 index 0141677b26a40..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) - -## ChromeHelpExtensionMenuDiscussLink.linkType property - -Creates a generic give feedback link with comment icon - -Signature: - -```typescript -linkType: 'discuss'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md deleted file mode 100644 index 3dc32fcb6d87f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) - -## ChromeHelpExtensionMenuDiscussLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | string | URL to discuss page. i.e. https://discuss.elastic.co/c/${appName} | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | 'discuss' | Creates a generic give feedback link with comment icon | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md deleted file mode 100644 index 9897bc6fcd2f7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) - -## ChromeHelpExtensionMenuDocumentationLink.href property - -URL to documentation page. i.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`, - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md deleted file mode 100644 index b75a70f9518b3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) - -## ChromeHelpExtensionMenuDocumentationLink.linkType property - -Creates a deep-link to app-specific documentation - -Signature: - -```typescript -linkType: 'documentation'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md deleted file mode 100644 index d20b513b1c550..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) - -## ChromeHelpExtensionMenuDocumentationLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | string | URL to documentation page. i.e. ${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html, | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | 'documentation' | Creates a deep-link to app-specific documentation | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md deleted file mode 100644 index 1976215e7243c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) - -## ChromeHelpExtensionMenuGitHubLink.labels property - -Include at least one app-specific label to be applied to the new github issue - -Signature: - -```typescript -labels: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md deleted file mode 100644 index b3df27213e5b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) - -## ChromeHelpExtensionMenuGitHubLink.linkType property - -Creates a link to a new github issue in the Kibana repo - -Signature: - -```typescript -linkType: 'github'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md deleted file mode 100644 index 56eee43d26902..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) - -## ChromeHelpExtensionMenuGitHubLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | string\[\] | Include at least one app-specific label to be applied to the new github issue | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | 'github' | Creates a link to a new github issue in the Kibana repo | -| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | string | (Optional) Provides initial text for the title of the issue | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md deleted file mode 100644 index af6091f9e7252..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) - -## ChromeHelpExtensionMenuGitHubLink.title property - -Provides initial text for the title of the issue - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md deleted file mode 100644 index cb7d795e3eb8e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) - -## ChromeHelpExtensionMenuLink type - - -Signature: - -```typescript -export declare type ChromeHelpExtensionMenuLink = ChromeHelpExtensionMenuGitHubLink | ChromeHelpExtensionMenuDiscussLink | ChromeHelpExtensionMenuDocumentationLink | ChromeHelpExtensionMenuCustomLink; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md deleted file mode 100644 index bcd67a8fe6f21..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) > [hideHelpMenu](./kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md) - -## ChromeHelpMenuActions.hideHelpMenu property - -Signature: - -```typescript -hideHelpMenu: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md deleted file mode 100644 index f33581cda5879..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) - -## ChromeHelpMenuActions interface - - -Signature: - -```typescript -export interface ChromeHelpMenuActions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hideHelpMenu](./kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md) | () => void | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md deleted file mode 100644 index c0371078c28a4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) - -## ChromeNavControl interface - - -Signature: - -```typescript -export interface ChromeNavControl -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | MountPoint | | -| [order?](./kibana-plugin-core-public.chromenavcontrol.order.md) | number | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md deleted file mode 100644 index 911fbe2131b52..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) > [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) - -## ChromeNavControl.mount property - -Signature: - -```typescript -mount: MountPoint; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md deleted file mode 100644 index ca6d865a68e4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) > [order](./kibana-plugin-core-public.chromenavcontrol.order.md) - -## ChromeNavControl.order property - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md deleted file mode 100644 index 72018d46428a4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) - -## ChromeNavControls interface - -[APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. - -Signature: - -```typescript -export interface ChromeNavControls -``` - -## Example - -Register a left-side nav control rendered with React. - -```jsx -chrome.navControls.registerLeft({ - mount(targetDomElement) { - ReactDOM.mount(, targetDomElement); - return () => ReactDOM.unmountComponentAtNode(targetDomElement); - } -}) -``` - -## Methods - -| Method | Description | -| --- | --- | -| [registerCenter(navControl)](./kibana-plugin-core-public.chromenavcontrols.registercenter.md) | Register a nav control to be presented on the top-center side of the chrome header. | -| [registerLeft(navControl)](./kibana-plugin-core-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the bottom-left side of the chrome header. | -| [registerRight(navControl)](./kibana-plugin-core-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the top-right side of the chrome header. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md deleted file mode 100644 index 68b243bf47f85..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerCenter](./kibana-plugin-core-public.chromenavcontrols.registercenter.md) - -## ChromeNavControls.registerCenter() method - -Register a nav control to be presented on the top-center side of the chrome header. - -Signature: - -```typescript -registerCenter(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md deleted file mode 100644 index ee0789c285f0b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerLeft](./kibana-plugin-core-public.chromenavcontrols.registerleft.md) - -## ChromeNavControls.registerLeft() method - -Register a nav control to be presented on the bottom-left side of the chrome header. - -Signature: - -```typescript -registerLeft(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md deleted file mode 100644 index 9091736c62eeb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerRight](./kibana-plugin-core-public.chromenavcontrols.registerright.md) - -## ChromeNavControls.registerRight() method - -Register a nav control to be presented on the top-right side of the chrome header. - -Signature: - -```typescript -registerRight(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md deleted file mode 100644 index 88dc54cf823b9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) - -## ChromeNavLink.baseUrl property - -The base route used to open the root of an application. - -Signature: - -```typescript -readonly baseUrl: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md deleted file mode 100644 index 1da313365f967..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [category](./kibana-plugin-core-public.chromenavlink.category.md) - -## ChromeNavLink.category property - -The category the app lives in - -Signature: - -```typescript -readonly category?: AppCategory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md deleted file mode 100644 index 2b4d22be187f9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [disabled](./kibana-plugin-core-public.chromenavlink.disabled.md) - -## ChromeNavLink.disabled property - -Disables a link from being clickable. - -Signature: - -```typescript -readonly disabled?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md deleted file mode 100644 index e30e8262f40b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [euiIconType](./kibana-plugin-core-public.chromenavlink.euiicontype.md) - -## ChromeNavLink.euiIconType property - -A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property. - -Signature: - -```typescript -readonly euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md deleted file mode 100644 index 8f8be18fa7bfa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [hidden](./kibana-plugin-core-public.chromenavlink.hidden.md) - -## ChromeNavLink.hidden property - -Hides a link from the navigation. - -Signature: - -```typescript -readonly hidden?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md deleted file mode 100644 index f51fa7e5b1355..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [href](./kibana-plugin-core-public.chromenavlink.href.md) - -## ChromeNavLink.href property - -Settled state between `url`, `baseUrl`, and `active` - -Signature: - -```typescript -readonly href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md deleted file mode 100644 index dbc922b2a9547..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [icon](./kibana-plugin-core-public.chromenavlink.icon.md) - -## ChromeNavLink.icon property - -A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided. - -Signature: - -```typescript -readonly icon?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md deleted file mode 100644 index a07f7963539ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [id](./kibana-plugin-core-public.chromenavlink.id.md) - -## ChromeNavLink.id property - -A unique identifier for looking up links. - -Signature: - -```typescript -readonly id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md deleted file mode 100644 index 964f4d4b86aaa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) - -## ChromeNavLink interface - - -Signature: - -```typescript -export interface ChromeNavLink -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | string | The base route used to open the root of an application. | -| [category?](./kibana-plugin-core-public.chromenavlink.category.md) | AppCategory | (Optional) The category the app lives in | -| [disabled?](./kibana-plugin-core-public.chromenavlink.disabled.md) | boolean | (Optional) Disables a link from being clickable. | -| [euiIconType?](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | string | (Optional) A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. | -| [hidden?](./kibana-plugin-core-public.chromenavlink.hidden.md) | boolean | (Optional) Hides a link from the navigation. | -| [href](./kibana-plugin-core-public.chromenavlink.href.md) | string | Settled state between url, baseUrl, and active | -| [icon?](./kibana-plugin-core-public.chromenavlink.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. | -| [id](./kibana-plugin-core-public.chromenavlink.id.md) | string | A unique identifier for looking up links. | -| [order?](./kibana-plugin-core-public.chromenavlink.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. | -| [title](./kibana-plugin-core-public.chromenavlink.title.md) | string | The title of the application. | -| [tooltip?](./kibana-plugin-core-public.chromenavlink.tooltip.md) | string | (Optional) A tooltip shown when hovering over an app link. | -| [url](./kibana-plugin-core-public.chromenavlink.url.md) | string | The route used to open the default path and the deep links of an application. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md deleted file mode 100644 index 3597a619a8b20..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [order](./kibana-plugin-core-public.chromenavlink.order.md) - -## ChromeNavLink.order property - -An ordinal used to sort nav links relative to one another for display. - -Signature: - -```typescript -readonly order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md deleted file mode 100644 index 43b1a08755aaf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [title](./kibana-plugin-core-public.chromenavlink.title.md) - -## ChromeNavLink.title property - -The title of the application. - -Signature: - -```typescript -readonly title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md deleted file mode 100644 index 551667dbbb35e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [tooltip](./kibana-plugin-core-public.chromenavlink.tooltip.md) - -## ChromeNavLink.tooltip property - -A tooltip shown when hovering over an app link. - -Signature: - -```typescript -readonly tooltip?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md deleted file mode 100644 index b9d12e450df50..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [url](./kibana-plugin-core-public.chromenavlink.url.md) - -## ChromeNavLink.url property - -The route used to open the default path and the deep links of an application. - -Signature: - -```typescript -readonly url: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md deleted file mode 100644 index 4f9b6aaada5db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [enableForcedAppSwitcherNavigation](./kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md) - -## ChromeNavLinks.enableForcedAppSwitcherNavigation() method - -Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated. - -Signature: - -```typescript -enableForcedAppSwitcherNavigation(): void; -``` -Returns: - -void - -## Remarks - -This is only necessary when rendering the status page in place of another app, as links to that app will set the current URL and change the hash, but the routes for the correct are not loaded so nothing will happen. https://github.com/elastic/kibana/pull/29770 - -Used only by status\_page plugin - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md deleted file mode 100644 index 796d99b9b0e0c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [get](./kibana-plugin-core-public.chromenavlinks.get.md) - -## ChromeNavLinks.get() method - -Get the state of a navlink at this point in time. - -Signature: - -```typescript -get(id: string): ChromeNavLink | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | - -Returns: - -ChromeNavLink \| undefined - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md deleted file mode 100644 index 08d5707fe3251..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getAll](./kibana-plugin-core-public.chromenavlinks.getall.md) - -## ChromeNavLinks.getAll() method - -Get the current state of all navlinks. - -Signature: - -```typescript -getAll(): Array>; -``` -Returns: - -Array<Readonly<ChromeNavLink>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md deleted file mode 100644 index 3b87790c37297..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getForceAppSwitcherNavigation$](./kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md) - -## ChromeNavLinks.getForceAppSwitcherNavigation$() method - -An observable of the forced app switcher state. - -Signature: - -```typescript -getForceAppSwitcherNavigation$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md deleted file mode 100644 index 8ee5c0fb83081..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getNavLinks$](./kibana-plugin-core-public.chromenavlinks.getnavlinks_.md) - -## ChromeNavLinks.getNavLinks$() method - -Get an observable for a sorted list of navlinks. - -Signature: - -```typescript -getNavLinks$(): Observable>>; -``` -Returns: - -Observable<Array<Readonly<ChromeNavLink>>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md deleted file mode 100644 index dfaae86a9d891..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [has](./kibana-plugin-core-public.chromenavlinks.has.md) - -## ChromeNavLinks.has() method - -Check whether or not a navlink exists. - -Signature: - -```typescript -has(id: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md deleted file mode 100644 index f71eb03d89d72..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) - -## ChromeNavLinks interface - -[APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. - -Signature: - -```typescript -export interface ChromeNavLinks -``` - -## Methods - -| Method | Description | -| --- | --- | -| [enableForcedAppSwitcherNavigation()](./kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md) | Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated. | -| [get(id)](./kibana-plugin-core-public.chromenavlinks.get.md) | Get the state of a navlink at this point in time. | -| [getAll()](./kibana-plugin-core-public.chromenavlinks.getall.md) | Get the current state of all navlinks. | -| [getForceAppSwitcherNavigation$()](./kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md) | An observable of the forced app switcher state. | -| [getNavLinks$()](./kibana-plugin-core-public.chromenavlinks.getnavlinks_.md) | Get an observable for a sorted list of navlinks. | -| [has(id)](./kibana-plugin-core-public.chromenavlinks.has.md) | Check whether or not a navlink exists. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md deleted file mode 100644 index 5c99c6bf7fbcb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [add](./kibana-plugin-core-public.chromerecentlyaccessed.add.md) - -## ChromeRecentlyAccessed.add() method - -Adds a new item to the recently accessed history. - -Signature: - -```typescript -add(link: string, label: string, id: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| link | string | a relative URL to the resource (not including the ) | -| label | string | the label to display in the UI | -| id | string | a unique string used to de-duplicate the recently accessed list. | - -Returns: - -void - -## Example - - -```js -chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234'); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md deleted file mode 100644 index da696737b3bb7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [get](./kibana-plugin-core-public.chromerecentlyaccessed.get.md) - -## ChromeRecentlyAccessed.get() method - -Gets an Array of the current recently accessed history. - -Signature: - -```typescript -get(): ChromeRecentlyAccessedHistoryItem[]; -``` -Returns: - -ChromeRecentlyAccessedHistoryItem\[\] - -## Example - - -```js -chrome.recentlyAccessed.get().forEach(console.log); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md deleted file mode 100644 index 4655289642f99..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [get$](./kibana-plugin-core-public.chromerecentlyaccessed.get_.md) - -## ChromeRecentlyAccessed.get$() method - -Gets an Observable of the array of recently accessed history. - -Signature: - -```typescript -get$(): Observable; -``` -Returns: - -Observable<ChromeRecentlyAccessedHistoryItem\[\]> - -## Example - - -```js -chrome.recentlyAccessed.get$().subscribe(console.log); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md deleted file mode 100644 index 4dad34fe86ed4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) - -## ChromeRecentlyAccessed interface - -[APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. - -Signature: - -```typescript -export interface ChromeRecentlyAccessed -``` - -## Methods - -| Method | Description | -| --- | --- | -| [add(link, label, id)](./kibana-plugin-core-public.chromerecentlyaccessed.add.md) | Adds a new item to the recently accessed history. | -| [get()](./kibana-plugin-core-public.chromerecentlyaccessed.get.md) | Gets an Array of the current recently accessed history. | -| [get$()](./kibana-plugin-core-public.chromerecentlyaccessed.get_.md) | Gets an Observable of the array of recently accessed history. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md deleted file mode 100644 index daf72d7ebd01c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) - -## ChromeRecentlyAccessedHistoryItem.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md deleted file mode 100644 index 5f55522e4fdf4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) - -## ChromeRecentlyAccessedHistoryItem.label property - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md deleted file mode 100644 index f4b702ba30c96..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) - -## ChromeRecentlyAccessedHistoryItem.link property - -Signature: - -```typescript -link: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md deleted file mode 100644 index 3b67b41d37a35..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) - -## ChromeRecentlyAccessedHistoryItem interface - - -Signature: - -```typescript -export interface ChromeRecentlyAccessedHistoryItem -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) | string | | -| [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) | string | | -| [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md deleted file mode 100644 index c42644eb149c8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) - -## ChromeStart.docTitle property - -APIs for accessing and updating the document title. - -Signature: - -```typescript -docTitle: ChromeDocTitle; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md deleted file mode 100644 index d3dc459bae9de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBadge$](./kibana-plugin-core-public.chromestart.getbadge_.md) - -## ChromeStart.getBadge$() method - -Get an observable of the current badge - -Signature: - -```typescript -getBadge$(): Observable; -``` -Returns: - -Observable<ChromeBadge \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md deleted file mode 100644 index c4d3751549b16..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBreadcrumbs$](./kibana-plugin-core-public.chromestart.getbreadcrumbs_.md) - -## ChromeStart.getBreadcrumbs$() method - -Get an observable of the current list of breadcrumbs - -Signature: - -```typescript -getBreadcrumbs$(): Observable; -``` -Returns: - -Observable<ChromeBreadcrumb\[\]> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md deleted file mode 100644 index 21c12514debec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBreadcrumbsAppendExtension$](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md) - -## ChromeStart.getBreadcrumbsAppendExtension$() method - -Get an observable of the current extension appended to breadcrumbs - -Signature: - -```typescript -getBreadcrumbsAppendExtension$(): Observable; -``` -Returns: - -Observable<ChromeBreadcrumbsAppendExtension \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md deleted file mode 100644 index 59346a409562e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getCustomNavLink$](./kibana-plugin-core-public.chromestart.getcustomnavlink_.md) - -## ChromeStart.getCustomNavLink$() method - -Get an observable of the current custom nav link - -Signature: - -```typescript -getCustomNavLink$(): Observable | undefined>; -``` -Returns: - -Observable<Partial<ChromeNavLink> \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md deleted file mode 100644 index 052bbe2630f70..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getHelpExtension$](./kibana-plugin-core-public.chromestart.gethelpextension_.md) - -## ChromeStart.getHelpExtension$() method - -Get an observable of the current custom help conttent - -Signature: - -```typescript -getHelpExtension$(): Observable; -``` -Returns: - -Observable<ChromeHelpExtension \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md deleted file mode 100644 index 12aa71366aaac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getIsNavDrawerLocked$](./kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md) - -## ChromeStart.getIsNavDrawerLocked$() method - -Get an observable of the current locked state of the nav drawer. - -Signature: - -```typescript -getIsNavDrawerLocked$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md deleted file mode 100644 index 70a9c832926e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getIsVisible$](./kibana-plugin-core-public.chromestart.getisvisible_.md) - -## ChromeStart.getIsVisible$() method - -Get an observable of the current visibility state of the chrome. - -Signature: - -```typescript -getIsVisible$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md deleted file mode 100644 index 66dd1e2562f50..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [hasHeaderBanner$](./kibana-plugin-core-public.chromestart.hasheaderbanner_.md) - -## ChromeStart.hasHeaderBanner$() method - -Get an observable of the current header banner presence state. - -Signature: - -```typescript -hasHeaderBanner$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.md deleted file mode 100644 index 3e672fbc14d75..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.md +++ /dev/null @@ -1,67 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) - -## ChromeStart interface - -ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. - -Signature: - -```typescript -export interface ChromeStart -``` - -## Remarks - -While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications. - -## Example 1 - -How to add a recently accessed item to the sidebar: - -```ts -core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234'); -``` - -## Example 2 - -How to set the help dropdown extension: - -```tsx -core.chrome.setHelpExtension(elem => { - ReactDOM.render(, elem); - return () => ReactDOM.unmountComponentAtNode(elem); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) | ChromeDocTitle | APIs for accessing and updating the document title. | -| [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) | ChromeNavControls | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. | -| [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) | ChromeNavLinks | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. | -| [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) | ChromeRecentlyAccessed | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. | - -## Methods - -| Method | Description | -| --- | --- | -| [getBadge$()](./kibana-plugin-core-public.chromestart.getbadge_.md) | Get an observable of the current badge | -| [getBreadcrumbs$()](./kibana-plugin-core-public.chromestart.getbreadcrumbs_.md) | Get an observable of the current list of breadcrumbs | -| [getBreadcrumbsAppendExtension$()](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md) | Get an observable of the current extension appended to breadcrumbs | -| [getCustomNavLink$()](./kibana-plugin-core-public.chromestart.getcustomnavlink_.md) | Get an observable of the current custom nav link | -| [getHelpExtension$()](./kibana-plugin-core-public.chromestart.gethelpextension_.md) | Get an observable of the current custom help conttent | -| [getIsNavDrawerLocked$()](./kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md) | Get an observable of the current locked state of the nav drawer. | -| [getIsVisible$()](./kibana-plugin-core-public.chromestart.getisvisible_.md) | Get an observable of the current visibility state of the chrome. | -| [hasHeaderBanner$()](./kibana-plugin-core-public.chromestart.hasheaderbanner_.md) | Get an observable of the current header banner presence state. | -| [setBadge(badge)](./kibana-plugin-core-public.chromestart.setbadge.md) | Override the current badge | -| [setBreadcrumbs(newBreadcrumbs)](./kibana-plugin-core-public.chromestart.setbreadcrumbs.md) | Override the current set of breadcrumbs | -| [setBreadcrumbsAppendExtension(breadcrumbsAppendExtension)](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md) | Mount an element next to the last breadcrumb | -| [setCustomNavLink(newCustomNavLink)](./kibana-plugin-core-public.chromestart.setcustomnavlink.md) | Override the current set of custom nav link | -| [setHeaderBanner(headerBanner)](./kibana-plugin-core-public.chromestart.setheaderbanner.md) | Set the banner that will appear on top of the chrome header. | -| [setHelpExtension(helpExtension)](./kibana-plugin-core-public.chromestart.sethelpextension.md) | Override the current set of custom help content | -| [setHelpSupportUrl(url)](./kibana-plugin-core-public.chromestart.sethelpsupporturl.md) | Override the default support URL shown in the help menu | -| [setIsVisible(isVisible)](./kibana-plugin-core-public.chromestart.setisvisible.md) | Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md deleted file mode 100644 index f2433d98066d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) - -## ChromeStart.navControls property - -[APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. - -Signature: - -```typescript -navControls: ChromeNavControls; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md deleted file mode 100644 index fb9222abbb211..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) - -## ChromeStart.navLinks property - -[APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. - -Signature: - -```typescript -navLinks: ChromeNavLinks; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md deleted file mode 100644 index 4eabb5bf0ba23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) - -## ChromeStart.recentlyAccessed property - -[APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. - -Signature: - -```typescript -recentlyAccessed: ChromeRecentlyAccessed; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md deleted file mode 100644 index 7e974b139d141..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBadge](./kibana-plugin-core-public.chromestart.setbadge.md) - -## ChromeStart.setBadge() method - -Override the current badge - -Signature: - -```typescript -setBadge(badge?: ChromeBadge): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| badge | ChromeBadge | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md deleted file mode 100644 index f44e3e6cfd562..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBreadcrumbs](./kibana-plugin-core-public.chromestart.setbreadcrumbs.md) - -## ChromeStart.setBreadcrumbs() method - -Override the current set of breadcrumbs - -Signature: - -```typescript -setBreadcrumbs(newBreadcrumbs: ChromeBreadcrumb[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newBreadcrumbs | ChromeBreadcrumb\[\] | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md deleted file mode 100644 index b8fa965f2726e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBreadcrumbsAppendExtension](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md) - -## ChromeStart.setBreadcrumbsAppendExtension() method - -Mount an element next to the last breadcrumb - -Signature: - -```typescript -setBreadcrumbsAppendExtension(breadcrumbsAppendExtension?: ChromeBreadcrumbsAppendExtension): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| breadcrumbsAppendExtension | ChromeBreadcrumbsAppendExtension | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md deleted file mode 100644 index 7b100a25a4b2b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setCustomNavLink](./kibana-plugin-core-public.chromestart.setcustomnavlink.md) - -## ChromeStart.setCustomNavLink() method - -Override the current set of custom nav link - -Signature: - -```typescript -setCustomNavLink(newCustomNavLink?: Partial): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newCustomNavLink | Partial<ChromeNavLink> | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md deleted file mode 100644 index 75f711c0bf10b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHeaderBanner](./kibana-plugin-core-public.chromestart.setheaderbanner.md) - -## ChromeStart.setHeaderBanner() method - -Set the banner that will appear on top of the chrome header. - -Signature: - -```typescript -setHeaderBanner(headerBanner?: ChromeUserBanner): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| headerBanner | ChromeUserBanner | | - -Returns: - -void - -## Remarks - -Using `undefined` when invoking this API will remove the banner. - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md deleted file mode 100644 index c2bc691349f3c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHelpExtension](./kibana-plugin-core-public.chromestart.sethelpextension.md) - -## ChromeStart.setHelpExtension() method - -Override the current set of custom help content - -Signature: - -```typescript -setHelpExtension(helpExtension?: ChromeHelpExtension): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| helpExtension | ChromeHelpExtension | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md deleted file mode 100644 index baeb37a89ca44..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHelpSupportUrl](./kibana-plugin-core-public.chromestart.sethelpsupporturl.md) - -## ChromeStart.setHelpSupportUrl() method - -Override the default support URL shown in the help menu - -Signature: - -```typescript -setHelpSupportUrl(url: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | The updated support URL | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md deleted file mode 100644 index 9c8cc737bea4f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setIsVisible](./kibana-plugin-core-public.chromestart.setisvisible.md) - -## ChromeStart.setIsVisible() method - -Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. - -Signature: - -```typescript -setIsVisible(isVisible: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| isVisible | boolean | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md b/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md deleted file mode 100644 index 7a77fdc6223de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) > [content](./kibana-plugin-core-public.chromeuserbanner.content.md) - -## ChromeUserBanner.content property - -Signature: - -```typescript -content: MountPoint; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md b/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md deleted file mode 100644 index 0417197ab55f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) - -## ChromeUserBanner interface - - -Signature: - -```typescript -export interface ChromeUserBanner -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [content](./kibana-plugin-core-public.chromeuserbanner.content.md) | MountPoint<HTMLDivElement> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md deleted file mode 100644 index 209a4e862589b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [analytics](./kibana-plugin-core-public.coresetup.analytics.md) - -## CoreSetup.analytics property - - -Signature: - -```typescript -analytics: AnalyticsServiceSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md deleted file mode 100644 index 70a1f3780577c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [application](./kibana-plugin-core-public.coresetup.application.md) - -## CoreSetup.application property - -[ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -Signature: - -```typescript -application: ApplicationSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md deleted file mode 100644 index be5689ad7b080..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md) - -## CoreSetup.executionContext property - -[ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) - -Signature: - -```typescript -executionContext: ExecutionContextSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md deleted file mode 100644 index 86f734c4b5c06..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) - -## CoreSetup.fatalErrors property - -[FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) - -Signature: - -```typescript -fatalErrors: FatalErrorsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md deleted file mode 100644 index 8664ad0e2a0e5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) - -## CoreSetup.getStartServices property - -[StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) - -Signature: - -```typescript -getStartServices: StartServicesAccessor; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md deleted file mode 100644 index d9b2599b0f80a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [http](./kibana-plugin-core-public.coresetup.http.md) - -## CoreSetup.http property - -[HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -Signature: - -```typescript -http: HttpSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md deleted file mode 100644 index 661702f2d466e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) - -## CoreSetup.injectedMetadata property - - -Signature: - -```typescript -injectedMetadata: InjectedMetadataSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.md deleted file mode 100644 index 051aa0218eca7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) - -## CoreSetup interface - -Core services exposed to the `Plugin` setup lifecycle - -Signature: - -```typescript -export interface CoreSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-public.coresetup.analytics.md) | AnalyticsServiceSetup | | -| [application](./kibana-plugin-core-public.coresetup.application.md) | ApplicationSetup | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | -| [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md) | ExecutionContextSetup | [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) | -| [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | FatalErrorsSetup | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | -| [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | StartServicesAccessor<TPluginsStart, TStart> | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) | -| [http](./kibana-plugin-core-public.coresetup.http.md) | HttpSetup | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | -| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | InjectedMetadataSetup | | -| [notifications](./kibana-plugin-core-public.coresetup.notifications.md) | NotificationsSetup | [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) | -| [theme](./kibana-plugin-core-public.coresetup.theme.md) | ThemeServiceSetup | | -| [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md deleted file mode 100644 index 9f5770539c83e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [notifications](./kibana-plugin-core-public.coresetup.notifications.md) - -## CoreSetup.notifications property - -[NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) - -Signature: - -```typescript -notifications: NotificationsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md deleted file mode 100644 index d1db31894563e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [theme](./kibana-plugin-core-public.coresetup.theme.md) - -## CoreSetup.theme property - - -Signature: - -```typescript -theme: ThemeServiceSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md deleted file mode 100644 index 60a7a2a984ba8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) - -## CoreSetup.uiSettings property - -[IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -uiSettings: IUiSettingsClient; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md b/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md deleted file mode 100644 index 0a12fa8e26164..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [analytics](./kibana-plugin-core-public.corestart.analytics.md) - -## CoreStart.analytics property - - -Signature: - -```typescript -analytics: AnalyticsServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.application.md b/docs/development/core/public/kibana-plugin-core-public.corestart.application.md deleted file mode 100644 index 95c1360098afe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.application.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [application](./kibana-plugin-core-public.corestart.application.md) - -## CoreStart.application property - -[ApplicationStart](./kibana-plugin-core-public.applicationstart.md) - -Signature: - -```typescript -application: ApplicationStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md b/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md deleted file mode 100644 index 38d72c54db264..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [chrome](./kibana-plugin-core-public.corestart.chrome.md) - -## CoreStart.chrome property - -[ChromeStart](./kibana-plugin-core-public.chromestart.md) - -Signature: - -```typescript -chrome: ChromeStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md b/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md deleted file mode 100644 index 624c4868d54a7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) - -## CoreStart.deprecations property - -[DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) - -Signature: - -```typescript -deprecations: DeprecationsServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md b/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md deleted file mode 100644 index 014e40b3e2203..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) - -## CoreStart.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md b/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md deleted file mode 100644 index 4a2239ee6a738..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) - -## CoreStart.executionContext property - -[ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) - -Signature: - -```typescript -executionContext: ExecutionContextStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md b/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md deleted file mode 100644 index 609d710618386..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) - -## CoreStart.fatalErrors property - -[FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) - -Signature: - -```typescript -fatalErrors: FatalErrorsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.http.md b/docs/development/core/public/kibana-plugin-core-public.corestart.http.md deleted file mode 100644 index b2123d149762d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [http](./kibana-plugin-core-public.corestart.http.md) - -## CoreStart.http property - -[HttpStart](./kibana-plugin-core-public.httpstart.md) - -Signature: - -```typescript -http: HttpStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md b/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md deleted file mode 100644 index 22ded9881e57e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [i18n](./kibana-plugin-core-public.corestart.i18n.md) - -## CoreStart.i18n property - -[I18nStart](./kibana-plugin-core-public.i18nstart.md) - -Signature: - -```typescript -i18n: I18nStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md b/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md deleted file mode 100644 index 57fadf8ea3354..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) - -## CoreStart.injectedMetadata property - - -Signature: - -```typescript -injectedMetadata: InjectedMetadataStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.md b/docs/development/core/public/kibana-plugin-core-public.corestart.md deleted file mode 100644 index 3ced931f53c7e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) - -## CoreStart interface - -Core services exposed to the `Plugin` start lifecycle - -Signature: - -```typescript -export interface CoreStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-public.corestart.analytics.md) | AnalyticsServiceStart | | -| [application](./kibana-plugin-core-public.corestart.application.md) | ApplicationStart | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | -| [chrome](./kibana-plugin-core-public.corestart.chrome.md) | ChromeStart | [ChromeStart](./kibana-plugin-core-public.chromestart.md) | -| [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | DeprecationsServiceStart | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | -| [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | DocLinksStart | | -| [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) | ExecutionContextStart | [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) | -| [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | FatalErrorsStart | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | -| [http](./kibana-plugin-core-public.corestart.http.md) | HttpStart | [HttpStart](./kibana-plugin-core-public.httpstart.md) | -| [i18n](./kibana-plugin-core-public.corestart.i18n.md) | I18nStart | [I18nStart](./kibana-plugin-core-public.i18nstart.md) | -| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | InjectedMetadataStart | | -| [notifications](./kibana-plugin-core-public.corestart.notifications.md) | NotificationsStart | [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) | -| [overlays](./kibana-plugin-core-public.corestart.overlays.md) | OverlayStart | [OverlayStart](./kibana-plugin-core-public.overlaystart.md) | -| [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) | SavedObjectsStart | [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) | -| [theme](./kibana-plugin-core-public.corestart.theme.md) | ThemeServiceStart | | -| [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md b/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md deleted file mode 100644 index 4e4e509e88e81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [notifications](./kibana-plugin-core-public.corestart.notifications.md) - -## CoreStart.notifications property - -[NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) - -Signature: - -```typescript -notifications: NotificationsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md b/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md deleted file mode 100644 index d65ac50b495ba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [overlays](./kibana-plugin-core-public.corestart.overlays.md) - -## CoreStart.overlays property - -[OverlayStart](./kibana-plugin-core-public.overlaystart.md) - -Signature: - -```typescript -overlays: OverlayStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md b/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md deleted file mode 100644 index 5216367abe293..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) - -## CoreStart.savedObjects property - -[SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) - -Signature: - -```typescript -savedObjects: SavedObjectsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md b/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md deleted file mode 100644 index 6482581805b46..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [theme](./kibana-plugin-core-public.corestart.theme.md) - -## CoreStart.theme property - - -Signature: - -```typescript -theme: ThemeServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md b/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md deleted file mode 100644 index 48348a5843963..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) - -## CoreStart.uiSettings property - -[IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -uiSettings: IUiSettingsClient; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md deleted file mode 100644 index 8175da8a1893a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) - -## DeprecationsServiceStart.getAllDeprecations property - -Grabs deprecations details for all domains. - -Signature: - -```typescript -getAllDeprecations: () => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md deleted file mode 100644 index 6e3472b7c3fe3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) - -## DeprecationsServiceStart.getDeprecations property - -Grabs deprecations for a specific domain. - -Signature: - -```typescript -getDeprecations: (domainId: string) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md deleted file mode 100644 index 842761f6b7cea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) - -## DeprecationsServiceStart.isDeprecationResolvable property - -Returns a boolean if the provided deprecation can be automatically resolvable. - -Signature: - -```typescript -isDeprecationResolvable: (details: DomainDeprecationDetails) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md deleted file mode 100644 index bfc1d78f4d045..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) - -## DeprecationsServiceStart interface - -DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. - -Signature: - -```typescript -export interface DeprecationsServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) | () => Promise<DomainDeprecationDetails\[\]> | Grabs deprecations details for all domains. | -| [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) | (domainId: string) => Promise<DomainDeprecationDetails\[\]> | Grabs deprecations for a specific domain. | -| [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) | (details: DomainDeprecationDetails) => boolean | Returns a boolean if the provided deprecation can be automatically resolvable. | -| [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) | (details: DomainDeprecationDetails) => Promise<ResolveDeprecationResponse> | Calls the correctiveActions.api to automatically resolve the depprecation. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md deleted file mode 100644 index fae623fed3cc2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) - -## DeprecationsServiceStart.resolveDeprecation property - -Calls the correctiveActions.api to automatically resolve the depprecation. - -Signature: - -```typescript -resolveDeprecation: (details: DomainDeprecationDetails) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md deleted file mode 100644 index c2bddc58d9c3b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) - -## ErrorToastOptions interface - -Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. - -Signature: - -```typescript -export interface ErrorToastOptions extends ToastOptions -``` -Extends: ToastOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | string | The title of the toast and the dialog when expanding the message. | -| [toastMessage?](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | string | (Optional) The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md deleted file mode 100644 index bad316896cf5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) > [title](./kibana-plugin-core-public.errortoastoptions.title.md) - -## ErrorToastOptions.title property - -The title of the toast and the dialog when expanding the message. - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md deleted file mode 100644 index a96143a94b211..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) > [toastMessage](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) - -## ErrorToastOptions.toastMessage property - -The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. - -Signature: - -```typescript -toastMessage?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md deleted file mode 100644 index 94936b94d0710..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [clear](./kibana-plugin-core-public.executioncontextsetup.clear.md) - -## ExecutionContextSetup.clear() method - -clears the context - -Signature: - -```typescript -clear(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md deleted file mode 100644 index d6c74db6d603e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [context$](./kibana-plugin-core-public.executioncontextsetup.context_.md) - -## ExecutionContextSetup.context$ property - -The current context observable - -Signature: - -```typescript -context$: Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md deleted file mode 100644 index 65e9b1218649d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [get](./kibana-plugin-core-public.executioncontextsetup.get.md) - -## ExecutionContextSetup.get() method - -Get the current top level context - -Signature: - -```typescript -get(): KibanaExecutionContext; -``` -Returns: - -KibanaExecutionContext - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md deleted file mode 100644 index 0f0bda4e2913e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [getAsLabels](./kibana-plugin-core-public.executioncontextsetup.getaslabels.md) - -## ExecutionContextSetup.getAsLabels() method - -returns apm labels - -Signature: - -```typescript -getAsLabels(): Labels; -``` -Returns: - -Labels - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md deleted file mode 100644 index 01581d2e80a5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) - -## ExecutionContextSetup interface - -Kibana execution context. Used to provide execution context to Elasticsearch, reporting, performance monitoring, etc. - -Signature: - -```typescript -export interface ExecutionContextSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context$](./kibana-plugin-core-public.executioncontextsetup.context_.md) | Observable<KibanaExecutionContext> | The current context observable | - -## Methods - -| Method | Description | -| --- | --- | -| [clear()](./kibana-plugin-core-public.executioncontextsetup.clear.md) | clears the context | -| [get()](./kibana-plugin-core-public.executioncontextsetup.get.md) | Get the current top level context | -| [getAsLabels()](./kibana-plugin-core-public.executioncontextsetup.getaslabels.md) | returns apm labels | -| [set(c$)](./kibana-plugin-core-public.executioncontextsetup.set.md) | Set the current top level context | -| [withGlobalContext(context)](./kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md) | merges the current top level context with the specific event context | - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md deleted file mode 100644 index e3dcea78c827a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [set](./kibana-plugin-core-public.executioncontextsetup.set.md) - -## ExecutionContextSetup.set() method - -Set the current top level context - -Signature: - -```typescript -set(c$: KibanaExecutionContext): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| c$ | KibanaExecutionContext | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md deleted file mode 100644 index 574d0fd989750..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [withGlobalContext](./kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md) - -## ExecutionContextSetup.withGlobalContext() method - -merges the current top level context with the specific event context - -Signature: - -```typescript -withGlobalContext(context?: KibanaExecutionContext): KibanaExecutionContext; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | KibanaExecutionContext | | - -Returns: - -KibanaExecutionContext - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md deleted file mode 100644 index 0d210ba5bb1c4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) - -## ExecutionContextStart type - -See [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md). - -Signature: - -```typescript -export declare type ExecutionContextStart = ExecutionContextSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md deleted file mode 100644 index 9b2803e4f12ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) - -## FatalErrorInfo interface - -Represents the `message` and `stack` of a fatal Error - -Signature: - -```typescript -export interface FatalErrorInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | string | | -| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | string \| undefined | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md deleted file mode 100644 index c623f7e6bf910..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) > [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) - -## FatalErrorInfo.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md deleted file mode 100644 index 5f8052be6a77a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) > [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) - -## FatalErrorInfo.stack property - -Signature: - -```typescript -stack: string | undefined; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md deleted file mode 100644 index 0b2a064a4c7df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) > [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) - -## FatalErrorsSetup.add property - -Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -add: (error: string | Error, source?: string) => never; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md deleted file mode 100644 index 15bf94d5b7cd6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) > [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) - -## FatalErrorsSetup.get$ property - -An Observable that will emit whenever a fatal error is added with `add()` - -Signature: - -```typescript -get$: () => Rx.Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md deleted file mode 100644 index 1f27fd52b7e32..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) - -## FatalErrorsSetup interface - -FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -export interface FatalErrorsSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) | (error: string \| Error, source?: string) => never | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. | -| [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) | () => Rx.Observable<FatalErrorInfo> | An Observable that will emit whenever a fatal error is added with add() | - diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md deleted file mode 100644 index dd462eb435369..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) - -## FatalErrorsStart type - -FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -export declare type FatalErrorsStart = FatalErrorsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md deleted file mode 100644 index 264e00a73fd2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [asResponse](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) - -## HttpFetchOptions.asResponse property - -When `true` the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When `false`, the return type will just be the parsed response body. Defaults to `false`. - -Signature: - -```typescript -asResponse?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md deleted file mode 100644 index f74a9d02f8420..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [asSystemRequest](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) - -## HttpFetchOptions.asSystemRequest property - -Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to `false`. - -Signature: - -```typescript -asSystemRequest?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md deleted file mode 100644 index 09ab95a5135f6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [context](./kibana-plugin-core-public.httpfetchoptions.context.md) - -## HttpFetchOptions.context property - -Signature: - -```typescript -context?: KibanaExecutionContext; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md deleted file mode 100644 index b29725b727cdb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [headers](./kibana-plugin-core-public.httpfetchoptions.headers.md) - -## HttpFetchOptions.headers property - -Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). - -Signature: - -```typescript -headers?: HttpHeadersInit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md deleted file mode 100644 index 9a7f05ab9cd3e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) - -## HttpFetchOptions interface - -All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md). - -Signature: - -```typescript -export interface HttpFetchOptions extends HttpRequestInit -``` -Extends: HttpRequestInit - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asResponse?](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | boolean | (Optional) When true the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When false, the return type will just be the parsed response body. Defaults to false. | -| [asSystemRequest?](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | boolean | (Optional) Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to false. | -| [context?](./kibana-plugin-core-public.httpfetchoptions.context.md) | KibanaExecutionContext | (Optional) | -| [headers?](./kibana-plugin-core-public.httpfetchoptions.headers.md) | HttpHeadersInit | (Optional) Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). | -| [prependBasePath?](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | boolean | (Optional) Whether or not the request should automatically prepend the basePath. Defaults to true. | -| [query?](./kibana-plugin-core-public.httpfetchoptions.query.md) | HttpFetchQuery | (Optional) The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md deleted file mode 100644 index ca638d472c52f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [prependBasePath](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) - -## HttpFetchOptions.prependBasePath property - -Whether or not the request should automatically prepend the basePath. Defaults to `true`. - -Signature: - -```typescript -prependBasePath?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md deleted file mode 100644 index b03e48aa15cc5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [query](./kibana-plugin-core-public.httpfetchoptions.query.md) - -## HttpFetchOptions.query property - -The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). - -Signature: - -```typescript -query?: HttpFetchQuery; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md deleted file mode 100644 index 78155adaf627e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) - -## HttpFetchOptionsWithPath interface - -Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included. - -Signature: - -```typescript -export interface HttpFetchOptionsWithPath extends HttpFetchOptions -``` -Extends: HttpFetchOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md deleted file mode 100644 index b360d7d1fb824..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) > [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) - -## HttpFetchOptionsWithPath.path property - -Signature: - -```typescript -path: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md deleted file mode 100644 index 29627ddd122fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md) - -## HttpFetchQuery interface - - -Signature: - -```typescript -export interface HttpFetchQuery -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httphandler.md b/docs/development/core/public/kibana-plugin-core-public.httphandler.md deleted file mode 100644 index 6a119b186bfa1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httphandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpHandler](./kibana-plugin-core-public.httphandler.md) - -## HttpHandler interface - -A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-core-public.httpresponse.md) for the response. - -Signature: - -```typescript -export interface HttpHandler -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md b/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md deleted file mode 100644 index e05303a23afc8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) - -## HttpHeadersInit interface - -Headers to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause [HttpHandler](./kibana-plugin-core-public.httphandler.md) to throw an error. - -Signature: - -```typescript -export interface HttpHeadersInit -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md deleted file mode 100644 index e1843b1a52988..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) - -## HttpInterceptor interface - -An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md). - -Signature: - -```typescript -export interface HttpInterceptor -``` - -## Methods - -| Method | Description | -| --- | --- | -| [request(fetchOptions, controller)?](./kibana-plugin-core-public.httpinterceptor.request.md) | (Optional) Define an interceptor to be executed before a request is sent. | -| [requestError(httpErrorRequest, controller)?](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | (Optional) Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. | -| [response(httpResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.response.md) | (Optional) Define an interceptor to be executed after a response is received. | -| [responseError(httpErrorResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | (Optional) Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md deleted file mode 100644 index 95181e6d509f1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [request](./kibana-plugin-core-public.httpinterceptor.request.md) - -## HttpInterceptor.request() method - -Define an interceptor to be executed before a request is sent. - -Signature: - -```typescript -request?(fetchOptions: Readonly, controller: IHttpInterceptController): MaybePromise> | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| fetchOptions | Readonly<HttpFetchOptionsWithPath> | | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<Partial<HttpFetchOptionsWithPath>> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md deleted file mode 100644 index c2bd14a6d1ead..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [requestError](./kibana-plugin-core-public.httpinterceptor.requesterror.md) - -## HttpInterceptor.requestError() method - -Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. - -Signature: - -```typescript -requestError?(httpErrorRequest: HttpInterceptorRequestError, controller: IHttpInterceptController): MaybePromise> | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpErrorRequest | HttpInterceptorRequestError | [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<Partial<HttpFetchOptionsWithPath>> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md deleted file mode 100644 index 40cfeffacc0ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [response](./kibana-plugin-core-public.httpinterceptor.response.md) - -## HttpInterceptor.response() method - -Define an interceptor to be executed after a response is received. - -Signature: - -```typescript -response?(httpResponse: HttpResponse, controller: IHttpInterceptController): MaybePromise | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpResponse | HttpResponse | [HttpResponse](./kibana-plugin-core-public.httpresponse.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<IHttpResponseInterceptorOverrides> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md deleted file mode 100644 index d9be2e87761fc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [responseError](./kibana-plugin-core-public.httpinterceptor.responseerror.md) - -## HttpInterceptor.responseError() method - -Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. - -Signature: - -```typescript -responseError?(httpErrorResponse: HttpInterceptorResponseError, controller: IHttpInterceptController): MaybePromise | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpErrorResponse | HttpInterceptorResponseError | [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<IHttpResponseInterceptorOverrides> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md deleted file mode 100644 index a5db2cb2664c1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) > [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) - -## HttpInterceptorRequestError.error property - -Signature: - -```typescript -error: Error; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md deleted file mode 100644 index 68c338b4f974d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) > [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) - -## HttpInterceptorRequestError.fetchOptions property - -Signature: - -```typescript -fetchOptions: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md deleted file mode 100644 index 499bc61ce68af..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) - -## HttpInterceptorRequestError interface - - -Signature: - -```typescript -export interface HttpInterceptorRequestError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) | Error | | -| [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) | Readonly<HttpFetchOptionsWithPath> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md deleted file mode 100644 index e69a3c04d1dec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) > [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) - -## HttpInterceptorResponseError.error property - -Signature: - -```typescript -error: Error | IHttpFetchError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md deleted file mode 100644 index 014cebeb3ec4d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) - -## HttpInterceptorResponseError interface - - -Signature: - -```typescript -export interface HttpInterceptorResponseError extends HttpResponse -``` -Extends: HttpResponse - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) | Error \| IHttpFetchError | | -| [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) | Readonly<Request> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md deleted file mode 100644 index 4e4d1bbdeec28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) > [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) - -## HttpInterceptorResponseError.request property - -Signature: - -```typescript -request: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md deleted file mode 100644 index dddf1ea87ec43..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [body](./kibana-plugin-core-public.httprequestinit.body.md) - -## HttpRequestInit.body property - -A BodyInit object or null to set request's body. - -Signature: - -```typescript -body?: BodyInit | null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md deleted file mode 100644 index cc7ef0bf2f3c2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [cache](./kibana-plugin-core-public.httprequestinit.cache.md) - -## HttpRequestInit.cache property - -The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. - -Signature: - -```typescript -cache?: RequestCache; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md deleted file mode 100644 index da05b9eb2e319..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [credentials](./kibana-plugin-core-public.httprequestinit.credentials.md) - -## HttpRequestInit.credentials property - -The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. - -Signature: - -```typescript -credentials?: RequestCredentials; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md deleted file mode 100644 index 64e79dc55d25d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [headers](./kibana-plugin-core-public.httprequestinit.headers.md) - -## HttpRequestInit.headers property - -[HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) - -Signature: - -```typescript -headers?: HttpHeadersInit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md deleted file mode 100644 index 34d9d2f60c969..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [integrity](./kibana-plugin-core-public.httprequestinit.integrity.md) - -## HttpRequestInit.integrity property - -Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. - -Signature: - -```typescript -integrity?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md deleted file mode 100644 index 3be81e863f5fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [keepalive](./kibana-plugin-core-public.httprequestinit.keepalive.md) - -## HttpRequestInit.keepalive property - -Whether or not request can outlive the global in which it was created. - -Signature: - -```typescript -keepalive?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md deleted file mode 100644 index 6b0e054ff1eb3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) - -## HttpRequestInit interface - -Fetch API options available to [HttpHandler](./kibana-plugin-core-public.httphandler.md)s. - -Signature: - -```typescript -export interface HttpRequestInit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.httprequestinit.body.md) | BodyInit \| null | (Optional) A BodyInit object or null to set request's body. | -| [cache?](./kibana-plugin-core-public.httprequestinit.cache.md) | RequestCache | (Optional) The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. | -| [credentials?](./kibana-plugin-core-public.httprequestinit.credentials.md) | RequestCredentials | (Optional) The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. | -| [headers?](./kibana-plugin-core-public.httprequestinit.headers.md) | HttpHeadersInit | (Optional) [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) | -| [integrity?](./kibana-plugin-core-public.httprequestinit.integrity.md) | string | (Optional) Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. | -| [keepalive?](./kibana-plugin-core-public.httprequestinit.keepalive.md) | boolean | (Optional) Whether or not request can outlive the global in which it was created. | -| [method?](./kibana-plugin-core-public.httprequestinit.method.md) | string | (Optional) HTTP method, which is "GET" by default. | -| [mode?](./kibana-plugin-core-public.httprequestinit.mode.md) | RequestMode | (Optional) The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. | -| [redirect?](./kibana-plugin-core-public.httprequestinit.redirect.md) | RequestRedirect | (Optional) The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. | -| [referrer?](./kibana-plugin-core-public.httprequestinit.referrer.md) | string | (Optional) The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made. | -| [referrerPolicy?](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | ReferrerPolicy | (Optional) The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. | -| [signal?](./kibana-plugin-core-public.httprequestinit.signal.md) | AbortSignal \| null | (Optional) Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. | -| [window?](./kibana-plugin-core-public.httprequestinit.window.md) | null | (Optional) Can only be null. Used to disassociate request from any Window. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md deleted file mode 100644 index f650c32f70701..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [method](./kibana-plugin-core-public.httprequestinit.method.md) - -## HttpRequestInit.method property - -HTTP method, which is "GET" by default. - -Signature: - -```typescript -method?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md deleted file mode 100644 index 4617b02c67420..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [mode](./kibana-plugin-core-public.httprequestinit.mode.md) - -## HttpRequestInit.mode property - -The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. - -Signature: - -```typescript -mode?: RequestMode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md deleted file mode 100644 index f1ae55f77f133..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [redirect](./kibana-plugin-core-public.httprequestinit.redirect.md) - -## HttpRequestInit.redirect property - -The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. - -Signature: - -```typescript -redirect?: RequestRedirect; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md deleted file mode 100644 index 19c0435742a91..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [referrer](./kibana-plugin-core-public.httprequestinit.referrer.md) - -## HttpRequestInit.referrer property - -The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. - -Signature: - -```typescript -referrer?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md deleted file mode 100644 index 30fc275ebf6bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [referrerPolicy](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) - -## HttpRequestInit.referrerPolicy property - -The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. - -Signature: - -```typescript -referrerPolicy?: ReferrerPolicy; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md deleted file mode 100644 index 8f309e7b877dc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [signal](./kibana-plugin-core-public.httprequestinit.signal.md) - -## HttpRequestInit.signal property - -Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. - -Signature: - -```typescript -signal?: AbortSignal | null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md deleted file mode 100644 index 6bafc9a03da58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [window](./kibana-plugin-core-public.httprequestinit.window.md) - -## HttpRequestInit.window property - -Can only be null. Used to disassociate request from any Window. - -Signature: - -```typescript -window?: null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md deleted file mode 100644 index 5d2cb693f63e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [body](./kibana-plugin-core-public.httpresponse.body.md) - -## HttpResponse.body property - -Parsed body received, may be undefined if there was an error. - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md deleted file mode 100644 index 19e74f0da9fba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) - -## HttpResponse.fetchOptions property - -The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. - -Signature: - -```typescript -readonly fetchOptions: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.md deleted file mode 100644 index c0a3644ecaf2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) - -## HttpResponse interface - - -Signature: - -```typescript -export interface HttpResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.httpresponse.body.md) | TResponseBody | (Optional) Parsed body received, may be undefined if there was an error. | -| [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) | Readonly<HttpFetchOptionsWithPath> | The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. | -| [request](./kibana-plugin-core-public.httpresponse.request.md) | Readonly<Request> | Raw request sent to Kibana server. | -| [response?](./kibana-plugin-core-public.httpresponse.response.md) | Readonly<Response> | (Optional) Raw response received, may be undefined if there was an error. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md deleted file mode 100644 index c21b0035835ba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [request](./kibana-plugin-core-public.httpresponse.request.md) - -## HttpResponse.request property - -Raw request sent to Kibana server. - -Signature: - -```typescript -readonly request: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md deleted file mode 100644 index 519412d2f4e46..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [response](./kibana-plugin-core-public.httpresponse.response.md) - -## HttpResponse.response property - -Raw response received, may be undefined if there was an error. - -Signature: - -```typescript -readonly response?: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md deleted file mode 100644 index 7962772dbaa5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [addLoadingCountSource](./kibana-plugin-core-public.httpsetup.addloadingcountsource.md) - -## HttpSetup.addLoadingCountSource() method - -Adds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are more than 0. - -Signature: - -```typescript -addLoadingCountSource(countSource$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| countSource$ | Observable<number> | an Observable to subscribe to for loading count updates. | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md deleted file mode 100644 index d640755f8174c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) - -## HttpSetup.anonymousPaths property - -APIs for denoting certain paths for not requiring authentication - -Signature: - -```typescript -anonymousPaths: IAnonymousPaths; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md deleted file mode 100644 index 15206a7ae5e1d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) - -## HttpSetup.basePath property - -APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md deleted file mode 100644 index 972af2fb55044..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [delete](./kibana-plugin-core-public.httpsetup.delete.md) - -## HttpSetup.delete property - -Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -delete: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md deleted file mode 100644 index b26c9d371e496..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) - -## HttpSetup.externalUrl property - -Signature: - -```typescript -externalUrl: IExternalUrl; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md deleted file mode 100644 index ad232598b71ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) - -## HttpSetup.fetch property - -Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -fetch: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md deleted file mode 100644 index 99b5d42643b59..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [get](./kibana-plugin-core-public.httpsetup.get.md) - -## HttpSetup.get property - -Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -get: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md deleted file mode 100644 index e10278470f542..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [getLoadingCount$](./kibana-plugin-core-public.httpsetup.getloadingcount_.md) - -## HttpSetup.getLoadingCount$() method - -Get the sum of all loading count sources as a single Observable. - -Signature: - -```typescript -getLoadingCount$(): Observable; -``` -Returns: - -Observable<number> - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md deleted file mode 100644 index 07faeae2a9c0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [head](./kibana-plugin-core-public.httpsetup.head.md) - -## HttpSetup.head property - -Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -head: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md deleted file mode 100644 index 27962d3c3867b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [intercept](./kibana-plugin-core-public.httpsetup.intercept.md) - -## HttpSetup.intercept() method - -Adds a new [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) to the global HTTP client. - -Signature: - -```typescript -intercept(interceptor: HttpInterceptor): () => void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| interceptor | HttpInterceptor | a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) | - -Returns: - -() => void - -a function for removing the attached interceptor. - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.md deleted file mode 100644 index 2d8116b0eeba6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -## HttpSetup interface - - -Signature: - -```typescript -export interface HttpSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) | IAnonymousPaths | APIs for denoting certain paths for not requiring authentication | -| [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) | IBasePath | APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) | -| [delete](./kibana-plugin-core-public.httpsetup.delete.md) | HttpHandler | Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) | IExternalUrl | | -| [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) | HttpHandler | Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [get](./kibana-plugin-core-public.httpsetup.get.md) | HttpHandler | Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [head](./kibana-plugin-core-public.httpsetup.head.md) | HttpHandler | Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [options](./kibana-plugin-core-public.httpsetup.options.md) | HttpHandler | Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [patch](./kibana-plugin-core-public.httpsetup.patch.md) | HttpHandler | Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [post](./kibana-plugin-core-public.httpsetup.post.md) | HttpHandler | Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [put](./kibana-plugin-core-public.httpsetup.put.md) | HttpHandler | Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | - -## Methods - -| Method | Description | -| --- | --- | -| [addLoadingCountSource(countSource$)](./kibana-plugin-core-public.httpsetup.addloadingcountsource.md) | Adds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are more than 0. | -| [getLoadingCount$()](./kibana-plugin-core-public.httpsetup.getloadingcount_.md) | Get the sum of all loading count sources as a single Observable. | -| [intercept(interceptor)](./kibana-plugin-core-public.httpsetup.intercept.md) | Adds a new [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) to the global HTTP client. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md deleted file mode 100644 index 9a83abcae0323..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [options](./kibana-plugin-core-public.httpsetup.options.md) - -## HttpSetup.options property - -Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -options: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md deleted file mode 100644 index 9024a12d527c2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [patch](./kibana-plugin-core-public.httpsetup.patch.md) - -## HttpSetup.patch property - -Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -patch: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md deleted file mode 100644 index fd30981a0ec56..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [post](./kibana-plugin-core-public.httpsetup.post.md) - -## HttpSetup.post property - -Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -post: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md deleted file mode 100644 index 599db3e61f504..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [put](./kibana-plugin-core-public.httpsetup.put.md) - -## HttpSetup.put property - -Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -put: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpstart.md b/docs/development/core/public/kibana-plugin-core-public.httpstart.md deleted file mode 100644 index 4cbbf6f07a2cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpStart](./kibana-plugin-core-public.httpstart.md) - -## HttpStart type - -See [HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -Signature: - -```typescript -export declare type HttpStart = HttpSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md b/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md deleted file mode 100644 index a0fba28be9681..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [I18nStart](./kibana-plugin-core-public.i18nstart.md) > [Context](./kibana-plugin-core-public.i18nstart.context.md) - -## I18nStart.Context property - -React Context provider required as the topmost component for any i18n-compatible React tree. - -Signature: - -```typescript -Context: ({ children }: { - children: React.ReactNode; - }) => JSX.Element; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.i18nstart.md b/docs/development/core/public/kibana-plugin-core-public.i18nstart.md deleted file mode 100644 index 586f5797abe6c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.i18nstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [I18nStart](./kibana-plugin-core-public.i18nstart.md) - -## I18nStart interface - -I18nStart.Context is required by any localizable React component from @kbn/i18n and @elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. - -Signature: - -```typescript -export interface I18nStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [Context](./kibana-plugin-core-public.i18nstart.context.md) | ({ children }: { children: React.ReactNode; }) => JSX.Element | React Context provider required as the topmost component for any i18n-compatible React tree. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md deleted file mode 100644 index 115285c84ea78..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) > [isAnonymous](./kibana-plugin-core-public.ianonymouspaths.isanonymous.md) - -## IAnonymousPaths.isAnonymous() method - -Determines whether the provided path doesn't require authentication. `path` should include the current basePath. - -Signature: - -```typescript -isAnonymous(path: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md deleted file mode 100644 index 91d66206dd9ee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) - -## IAnonymousPaths interface - -APIs for denoting paths as not requiring authentication - -Signature: - -```typescript -export interface IAnonymousPaths -``` - -## Methods - -| Method | Description | -| --- | --- | -| [isAnonymous(path)](./kibana-plugin-core-public.ianonymouspaths.isanonymous.md) | Determines whether the provided path doesn't require authentication. path should include the current basePath. | -| [register(path)](./kibana-plugin-core-public.ianonymouspaths.register.md) | Register path as not requiring authentication. path should not include the current basePath. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md deleted file mode 100644 index bfcc0f6decd5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) > [register](./kibana-plugin-core-public.ianonymouspaths.register.md) - -## IAnonymousPaths.register() method - -Register `path` as not requiring authentication. `path` should not include the current basePath. - -Signature: - -```typescript -register(path: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md deleted file mode 100644 index ed27de777b715..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [get](./kibana-plugin-core-public.ibasepath.get.md) - -## IBasePath.get property - -Gets the `basePath` string. - -Signature: - -```typescript -get: () => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.md deleted file mode 100644 index 72a863f7d515c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) - -## IBasePath interface - -APIs for manipulating the basePath on URL segments. - -Signature: - -```typescript -export interface IBasePath -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-public.ibasepath.get.md) | () => string | Gets the basePath string. | -| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | (url: string) => string | Prepends path with the basePath. | -| [publicBaseUrl?](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). | -| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | (url: string) => string | Removes the prepended basePath from the path. | -| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | string | Returns the server's root basePath as configured, without any namespace prefix.See for getting the basePath value for a specific request | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md deleted file mode 100644 index b3e55351d350f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) - -## IBasePath.prepend property - -Prepends `path` with the basePath. - -Signature: - -```typescript -prepend: (url: string) => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md deleted file mode 100644 index f45cc6eba2959..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [publicBaseUrl](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) - -## IBasePath.publicBaseUrl property - -The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). - -Signature: - -```typescript -readonly publicBaseUrl?: string; -``` - -## Remarks - -Should be used for generating external URL links back to this Kibana instance. - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md deleted file mode 100644 index 2fcbe487e95b3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [remove](./kibana-plugin-core-public.ibasepath.remove.md) - -## IBasePath.remove property - -Removes the prepended basePath from the `path`. - -Signature: - -```typescript -remove: (url: string) => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md deleted file mode 100644 index f800b792e7b7f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) - -## IBasePath.serverBasePath property - -Returns the server's root basePath as configured, without any namespace prefix. - -See for getting the basePath value for a specific request - -Signature: - -```typescript -readonly serverBasePath: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md deleted file mode 100644 index 396e5586f1fed..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) > [isInternalUrl](./kibana-plugin-core-public.iexternalurl.isinternalurl.md) - -## IExternalUrl.isInternalUrl() method - -Determines if the provided URL is an internal url. - -Signature: - -```typescript -isInternalUrl(relativeOrAbsoluteUrl: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| relativeOrAbsoluteUrl | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md deleted file mode 100644 index d0d4e6a3a4464..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) - -## IExternalUrl interface - -APIs for working with external URLs. - -Signature: - -```typescript -export interface IExternalUrl -``` - -## Methods - -| Method | Description | -| --- | --- | -| [isInternalUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.isinternalurl.md) | Determines if the provided URL is an internal url. | -| [validateUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.validateurl.md) | Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml.If the URL is valid, then a URL will be returned. Otherwise, this will return null. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md deleted file mode 100644 index 24140effc45d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) > [validateUrl](./kibana-plugin-core-public.iexternalurl.validateurl.md) - -## IExternalUrl.validateUrl() method - -Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml. - -If the URL is valid, then a URL will be returned. Otherwise, this will return null. - -Signature: - -```typescript -validateUrl(relativeOrAbsoluteUrl: string): URL | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| relativeOrAbsoluteUrl | string | | - -Returns: - -URL \| null - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md deleted file mode 100644 index ec7129a43b99a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) - -## IExternalUrlPolicy.allow property - -Indicates if this policy allows or denies access to the described destination. - -Signature: - -```typescript -allow: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md deleted file mode 100644 index 1d3c9fc9bbaf1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) - -## IExternalUrlPolicy.host property - -Optional host describing the external destination. May be combined with `protocol`. - -Signature: - -```typescript -host?: string; -``` - -## Example - - -```ts -// allows access to all of google.com, using any protocol. -allow: true, -host: 'google.com' -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md deleted file mode 100644 index 6623fec18d976..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) - -## IExternalUrlPolicy interface - -A policy describing whether access to an external destination is allowed. - -Signature: - -```typescript -export interface IExternalUrlPolicy -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. | -| [host?](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined with protocol. | -| [protocol?](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md deleted file mode 100644 index 6b6f8b9638bb8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) - -## IExternalUrlPolicy.protocol property - -Optional protocol describing the external destination. May be combined with `host`. - -Signature: - -```typescript -protocol?: string; -``` - -## Example - - -```ts -// allows access to all destinations over the `https` protocol. -allow: true, -protocol: 'https' -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md deleted file mode 100644 index d053a5a9d360c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [body](./kibana-plugin-core-public.ihttpfetcherror.body.md) - -## IHttpFetchError.body property - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md deleted file mode 100644 index 9aaae1be72028..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) - -## IHttpFetchError interface - - -Signature: - -```typescript -export interface IHttpFetchError extends Error -``` -Extends: Error - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.ihttpfetcherror.body.md) | TResponseBody | (Optional) | -| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | string | | -| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | Request | | -| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | Request | | -| [res?](./kibana-plugin-core-public.ihttpfetcherror.res.md) | Response | (Optional) | -| [response?](./kibana-plugin-core-public.ihttpfetcherror.response.md) | Response | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md deleted file mode 100644 index 4ab1ddd4b90ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) - -## IHttpFetchError.name property - -Signature: - -```typescript -readonly name: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md deleted file mode 100644 index eb1c158156e5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) - -## IHttpFetchError.req property - -> Warning: This API is now obsolete. -> -> Provided for legacy compatibility. Prefer the `request` property instead. 8.8.0 -> -> Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. -> - -Signature: - -```typescript -readonly req: Request; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md deleted file mode 100644 index 193d4cf92587e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) - -## IHttpFetchError.request property - -Signature: - -```typescript -readonly request: Request; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md deleted file mode 100644 index 4440986db4ff8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [res](./kibana-plugin-core-public.ihttpfetcherror.res.md) - -## IHttpFetchError.res property - -> Warning: This API is now obsolete. -> -> Provided for legacy compatibility. Prefer the `response` property instead. 8.8.0 -> -> Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. -> - -Signature: - -```typescript -readonly res?: Response; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md deleted file mode 100644 index 1f7fcc746e19b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [response](./kibana-plugin-core-public.ihttpfetcherror.response.md) - -## IHttpFetchError.response property - -Signature: - -```typescript -readonly response?: Response; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md deleted file mode 100644 index b982e4dbac8a6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) > [halt](./kibana-plugin-core-public.ihttpinterceptcontroller.halt.md) - -## IHttpInterceptController.halt() method - -Halt the request Promise chain and do not process further interceptors or response handlers. - -Signature: - -```typescript -halt(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md deleted file mode 100644 index 82e5378412a5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) > [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) - -## IHttpInterceptController.halted property - -Whether or not this chain has been halted. - -Signature: - -```typescript -halted: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md deleted file mode 100644 index 15a66ef569e7d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) - -## IHttpInterceptController interface - -Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md). - -Signature: - -```typescript -export interface IHttpInterceptController -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | boolean | Whether or not this chain has been halted. | - -## Methods - -| Method | Description | -| --- | --- | -| [halt()](./kibana-plugin-core-public.ihttpinterceptcontroller.halt.md) | Halt the request Promise chain and do not process further interceptors or response handlers. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md deleted file mode 100644 index 70dfe72d62ac5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) > [body](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md) - -## IHttpResponseInterceptorOverrides.body property - -Parsed body received, may be undefined if there was an error. - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md deleted file mode 100644 index 57a4555cd6da5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) - -## IHttpResponseInterceptorOverrides interface - -Properties that can be returned by HttpInterceptor.request to override the response. - -Signature: - -```typescript -export interface IHttpResponseInterceptorOverrides -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md) | TResponseBody | (Optional) Parsed body received, may be undefined if there was an error. | -| [response?](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md) | Readonly<Response> | (Optional) Raw response received, may be undefined if there was an error. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md deleted file mode 100644 index c858200c2113f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) > [response](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md) - -## IHttpResponseInterceptorOverrides.response property - -Raw response received, may be undefined if there was an error. - -Signature: - -```typescript -readonly response?: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.itoasts.md b/docs/development/core/public/kibana-plugin-core-public.itoasts.md deleted file mode 100644 index e009c77fe23bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.itoasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IToasts](./kibana-plugin-core-public.itoasts.md) - -## IToasts type - -Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-core-public.toastsapi.md). - -Signature: - -```typescript -export declare type IToasts = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md deleted file mode 100644 index 903b6ff4bad1f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [get](./kibana-plugin-core-public.iuisettingsclient.get.md) - -## IUiSettingsClient.get property - -Gets the value for a specific uiSetting. If this setting has no user-defined value then the `defaultOverride` parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. - -Signature: - -```typescript -get: (key: string, defaultOverride?: T) => T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md deleted file mode 100644 index 2ba20c34e81a5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) - -## IUiSettingsClient.get$ property - -Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a `defaultOverride` argument behaves the same as it does in \#get() - -Signature: - -```typescript -get$: (key: string, defaultOverride?: T) => Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md deleted file mode 100644 index 004979977376e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) - -## IUiSettingsClient.getAll property - -Gets the metadata about all uiSettings, including the type, default value, and user value for each key. - -Signature: - -```typescript -getAll: () => Readonly>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md deleted file mode 100644 index e9a8bf7cceece..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) - -## IUiSettingsClient.getUpdate$ property - -Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. - -Signature: - -```typescript -getUpdate$: () => Observable<{ - key: string; - newValue: T; - oldValue: T; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md deleted file mode 100644 index 6270f4b553434..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getUpdateErrors$](./kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md) - -## IUiSettingsClient.getUpdateErrors$ property - -Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. - -Signature: - -```typescript -getUpdateErrors$: () => Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md deleted file mode 100644 index 8d3b2d9d37139..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) - -## IUiSettingsClient.isCustom property - -Returns true if the setting wasn't registered by any plugin, but was either added directly via `set()`, or is an unknown setting found in the uiSettings saved object - -Signature: - -```typescript -isCustom: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md deleted file mode 100644 index 39c8a32202691..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) - -## IUiSettingsClient.isDeclared property - -Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the `set()` method. - -Signature: - -```typescript -isDeclared: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md deleted file mode 100644 index 4a1b948bf0aca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) - -## IUiSettingsClient.isDefault property - -Returns true if the setting has no user-defined value or is unknown - -Signature: - -```typescript -isDefault: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md deleted file mode 100644 index 0684c3617e434..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) - -## IUiSettingsClient.isOverridden property - -Shows whether the uiSettings value set by the user. - -Signature: - -```typescript -isOverridden: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md deleted file mode 100644 index 5d2429a799fe6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -## IUiSettingsClient interface - -Client-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -export interface IUiSettingsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-public.iuisettingsclient.get.md) | <T = any>(key: string, defaultOverride?: T) => T | Gets the value for a specific uiSetting. If this setting has no user-defined value then the defaultOverride parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. | -| [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) | <T = any>(key: string, defaultOverride?: T) => Observable<T> | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a defaultOverride argument behaves the same as it does in \#get() | -| [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) | () => Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>> | Gets the metadata about all uiSettings, including the type, default value, and user value for each key. | -| [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) | <T = any>() => Observable<{ key: string; newValue: T; oldValue: T; }> | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. | -| [getUpdateErrors$](./kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md) | () => Observable<Error> | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. | -| [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) | (key: string) => boolean | Returns true if the setting wasn't registered by any plugin, but was either added directly via set(), or is an unknown setting found in the uiSettings saved object | -| [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) | (key: string) => boolean | Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the set() method. | -| [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) | (key: string) => boolean | Returns true if the setting has no user-defined value or is unknown | -| [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. | -| [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) | (key: string) => Promise<boolean> | Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling set(key, null), including the synchronization, custom setting, and error behavior of that method. | -| [set](./kibana-plugin-core-public.iuisettingsclient.set.md) | (key: string, value: any) => Promise<boolean> | Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the get() method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before set() was called. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md deleted file mode 100644 index b6d4ff04cf4a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) - -## IUiSettingsClient.remove property - -Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling `set(key, null)`, including the synchronization, custom setting, and error behavior of that method. - -Signature: - -```typescript -remove: (key: string) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md deleted file mode 100644 index ea817c39980ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [set](./kibana-plugin-core-public.iuisettingsclient.set.md) - -## IUiSettingsClient.set property - -Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the `get()` method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before `set()` was called. - -Signature: - -```typescript -set: (key: string, value: any) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md b/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md deleted file mode 100644 index d8f8a77d84b2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) - -## KibanaExecutionContext type - -Represents a meta-information about a Kibana entity initiating a search request. - -Signature: - -```typescript -export declare type KibanaExecutionContext = { - readonly type?: string; - readonly name?: string; - readonly page?: string; - readonly id?: string; - readonly description?: string; - readonly url?: string; - child?: KibanaExecutionContext; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.md b/docs/development/core/public/kibana-plugin-core-public.md deleted file mode 100644 index 1d2b07d13f6a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.md +++ /dev/null @@ -1,185 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) - -## kibana-plugin-core-public package - -The Kibana Core APIs for client-side plugins. - -A plugin's `public/index` file must contain a named import, `plugin`, that implements [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) which returns an object that implements . - -The plugin integrates with the core system via lifecycle events: `setup`, `start`, and `stop`. In each lifecycle method, the plugin will receive the corresponding core services available (either [CoreSetup](./kibana-plugin-core-public.coresetup.md) or [CoreStart](./kibana-plugin-core-public.corestart.md)) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. - -## Classes - -| Class | Description | -| --- | --- | -| [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) | A wrapper around a History instance that is scoped to a particular base path of the history stack. Behaves similarly to the basename option except that this wrapper hides any history stack entries from outside the scope of this base path.This wrapper also allows Core and Plugins to share a single underlying global History instance without exposing the history of other applications.The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. | -| [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md).It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. | -| [ToastsApi](./kibana-plugin-core-public.toastsapi.md) | Methods for adding and removing global toast messages. | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AppLeaveActionType](./kibana-plugin-core-public.appleaveactiontype.md) | Possible type of actions on application leave. | -| [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) | Status of the application's navLink. | -| [AppStatus](./kibana-plugin-core-public.appstatus.md) | Accessibility status of an application. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [App](./kibana-plugin-core-public.app.md) | | -| [AppCategory](./kibana-plugin-core-public.appcategory.md) | A category definition for nav links to know where to sort them in the left hand nav | -| [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application.See | -| [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application.See | -| [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | | -| [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | | -| [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) | | -| [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) | App navigation menu options | -| [Capabilities](./kibana-plugin-core-public.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. | -| [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) | | -| [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) | APIs for accessing and updating the document title. | -| [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) | | -| [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) | | -| [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) | | -| [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) | | -| [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) | | -| [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) | | -| [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) | | -| [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. | -| [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) | | -| [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. | -| [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. | -| [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) | | -| [ChromeStart](./kibana-plugin-core-public.chromestart.md) | ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. | -| [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) | | -| [CoreSetup](./kibana-plugin-core-public.coresetup.md) | Core services exposed to the Plugin setup lifecycle | -| [CoreStart](./kibana-plugin-core-public.corestart.md) | Core services exposed to the Plugin start lifecycle | -| [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. | -| [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. | -| [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) | Kibana execution context. Used to provide execution context to Elasticsearch, reporting, performance monitoring, etc. | -| [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) | Represents the message and stack of a fatal Error | -| [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. | -| [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) | All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md). | -| [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) | Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included. | -| [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md) | | -| [HttpHandler](./kibana-plugin-core-public.httphandler.md) | A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-core-public.httpresponse.md) for the response. | -| [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) | Headers to append to the request. Any headers that begin with kbn- are considered private to Core and will cause [HttpHandler](./kibana-plugin-core-public.httphandler.md) to throw an error. | -| [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) | An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md). | -| [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) | | -| [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) | | -| [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) | Fetch API options available to [HttpHandler](./kibana-plugin-core-public.httphandler.md)s. | -| [HttpResponse](./kibana-plugin-core-public.httpresponse.md) | | -| [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | | -| [I18nStart](./kibana-plugin-core-public.i18nstart.md) | I18nStart.Context is required by any localizable React component from @kbn/i18n and @elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. | -| [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) | APIs for denoting paths as not requiring authentication | -| [IBasePath](./kibana-plugin-core-public.ibasepath.md) | APIs for manipulating the basePath on URL segments. | -| [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) | APIs for working with external URLs. | -| [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) | A policy describing whether access to an external destination is allowed. | -| [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) | | -| [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md). | -| [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) | Properties that can be returned by HttpInterceptor.request to override the response. | -| [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | Client-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | -| [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) | Options for the [navigateToApp API](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | -| [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) | Options for the [navigateToUrl API](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | -| [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) | | -| [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) | | -| [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) | | -| [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) | | -| [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) | APIs to open and manage fly-out dialogs. | -| [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) | | -| [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) | | -| [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) | APIs to open and manage modal dialogs. | -| [OverlayRef](./kibana-plugin-core-public.overlayref.md) | Returned by [OverlayStart](./kibana-plugin-core-public.overlaystart.md) methods for closing a mounted overlay. | -| [OverlayStart](./kibana-plugin-core-public.overlaystart.md) | | -| [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) | The interface that should be returned by a PluginInitializer. | -| [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) | The available core services passed to a PluginInitializer | -| [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) | This interface is a very simple wrapper for SavedObjects resolved from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). | -| [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) | | -| [SavedObject](./kibana-plugin-core-public.savedobject.md) | | -| [SavedObjectAttributes](./kibana-plugin-core-public.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the attributes property. | -| [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) | | -| [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) | A reference to another saved object. | -| [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) | A returned input object or one of its references, with additional context. | -| [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) | | -| [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) | | -| [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) | | -| [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) | | -| [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) | | -| [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) | | -| [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) | | -| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) | | -| [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) | The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. | -| [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) | The response when object references are collected. | -| [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) | | -| [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) | | -| [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) | | -| [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects find() method.\*Note\*: this type is different between the Public and Server Saved Objects clients. | -| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) | A warning meant to notify that a specific user action is required to finalize the import of some type of object. The actionUrl must be a path relative to the basePath, and not include it. | -| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. | -| [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. | -| [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) | Represents a failure to import. | -| [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. | -| [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) | The response describing the result of an import. | -| [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. | -| [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) | A simple informative warning that will be displayed to the user. | -| [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) | Represents a successful import. | -| [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. | -| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. | -| [SavedObjectsMigrationVersion](./kibana-plugin-core-public.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) | | -| [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) | | -| [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) | | -| [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. | -| [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) | UiSettings parameters defined by the plugins. | -| [UiSettingsState](./kibana-plugin-core-public.uisettingsstate.md) | | -| [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) | Describes the values explicitly set by user. | - -## Variables - -| Variable | Description | -| --- | --- | -| [APP\_WRAPPER\_CLASS](./kibana-plugin-core-public.app_wrapper_class.md) | The class name for top level \*and\* nested application wrappers to ensure proper layout | -| [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md) | The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) | Input type for registering secondary in-app locations for an application.Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | -| [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) | Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) | -| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) | A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return confirm to prompt a message to the user before leaving the page, or default to keep the default behavior (doing nothing).See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. | -| [AppMount](./kibana-plugin-core-public.appmount.md) | A mount function called when the user navigates to this app's route. | -| [AppUnmount](./kibana-plugin-core-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. | -| [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) | Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md). | -| [AppUpdater](./kibana-plugin-core-public.appupdater.md) | Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | -| [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md) | | -| [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) | | -| [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) | | -| [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) | See [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md). | -| [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. | -| [HttpStart](./kibana-plugin-core-public.httpstart.md) | See [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | -| [IToasts](./kibana-plugin-core-public.itoasts.md) | Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-core-public.toastsapi.md). | -| [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) | Represents a meta-information about a Kibana entity initiating a search request. | -| [MountPoint](./kibana-plugin-core-public.mountpoint.md) | A function that should mount DOM content inside the provided container element and return a handler to unmount it. | -| [NavType](./kibana-plugin-core-public.navtype.md) | | -| [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) | The plugin export at the root of a plugin's public directory should conform to this interface. | -| [PublicAppDeepLinkInfo](./kibana-plugin-core-public.publicappdeeplinkinfo.md) | Public information about a registered app's [deepLinks](./kibana-plugin-core-public.appdeeplink.md) | -| [PublicAppInfo](./kibana-plugin-core-public.publicappinfo.md) | Public information about a registered [application](./kibana-plugin-core-public.app.md) | -| [PublicUiSettingsParams](./kibana-plugin-core-public.publicuisettingsparams.md) | A sub-set of [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) exposed to the client-side. | -| [ResolveDeprecationResponse](./kibana-plugin-core-public.resolvedeprecationresponse.md) | | -| [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | Type definition for a Saved Object attribute value | -| [SavedObjectAttributeSingle](./kibana-plugin-core-public.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | -| [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) | Composite type of all the possible types of import warnings.See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details. | -| [SavedObjectsNamespaceType](./kibana-plugin-core-public.savedobjectsnamespacetype.md) | The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. | -| [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers, such as [App.mount](./kibana-plugin-core-public.app.mount.md). Promise will not resolve until Core and plugin dependencies have completed start. | -| [Toast](./kibana-plugin-core-public.toast.md) | | -| [ToastInput](./kibana-plugin-core-public.toastinput.md) | Inputs for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. | -| [ToastInputFields](./kibana-plugin-core-public.toastinputfields.md) | Allowed fields for [ToastInput](./kibana-plugin-core-public.toastinput.md). | -| [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) | [IToasts](./kibana-plugin-core-public.itoasts.md) | -| [ToastsStart](./kibana-plugin-core-public.toastsstart.md) | [IToasts](./kibana-plugin-core-public.itoasts.md) | -| [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) | UI element type to represent the settings. | -| [UnmountCallback](./kibana-plugin-core-public.unmountcallback.md) | A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-core-public.mountpoint.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md b/docs/development/core/public/kibana-plugin-core-public.mountpoint.md deleted file mode 100644 index 41c6269b3e6da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [MountPoint](./kibana-plugin-core-public.mountpoint.md) - -## MountPoint type - -A function that should mount DOM content inside the provided container element and return a handler to unmount it. - -Signature: - -```typescript -export declare type MountPoint = (element: T) => UnmountCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md deleted file mode 100644 index 4039e1338fc1c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [deepLinkId](./kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md) - -## NavigateToAppOptions.deepLinkId property - -optional [deep link](./kibana-plugin-core-public.app.deeplinks.md) id inside the application to navigate to. If an additional [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) is defined it will be appended to the deep link path. - -Signature: - -```typescript -deepLinkId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md deleted file mode 100644 index 337e9db1f80d2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) - -## NavigateToAppOptions interface - -Options for the [navigateToApp API](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) - -Signature: - -```typescript -export interface NavigateToAppOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deepLinkId?](./kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md) | string | (Optional) optional [deep link](./kibana-plugin-core-public.app.deeplinks.md) id inside the application to navigate to. If an additional [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) is defined it will be appended to the deep link path. | -| [openInNewTab?](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) | boolean | (Optional) if true, will open the app in new tab, will share session information via window.open if base | -| [path?](./kibana-plugin-core-public.navigatetoappoptions.path.md) | string | (Optional) optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default. | -| [replace?](./kibana-plugin-core-public.navigatetoappoptions.replace.md) | boolean | (Optional) if true, will not create a new history entry when navigating (using replace instead of push) | -| [skipAppLeave?](./kibana-plugin-core-public.navigatetoappoptions.skipappleave.md) | boolean | (Optional) if true, will bypass the default onAppLeave behavior | -| [state?](./kibana-plugin-core-public.navigatetoappoptions.state.md) | unknown | (Optional) optional state to forward to the application | - diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md deleted file mode 100644 index 4609fa68b3824..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [openInNewTab](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) - -## NavigateToAppOptions.openInNewTab property - -if true, will open the app in new tab, will share session information via window.open if base - -Signature: - -```typescript -openInNewTab?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md deleted file mode 100644 index b39fc8c324ad9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) - -## NavigateToAppOptions.path property - -optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default. - -Signature: - -```typescript -path?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md deleted file mode 100644 index 8a7440025aedc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [replace](./kibana-plugin-core-public.navigatetoappoptions.replace.md) - -## NavigateToAppOptions.replace property - -if true, will not create a new history entry when navigating (using `replace` instead of `push`) - -Signature: - -```typescript -replace?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md deleted file mode 100644 index 553d557a92daa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [skipAppLeave](./kibana-plugin-core-public.navigatetoappoptions.skipappleave.md) - -## NavigateToAppOptions.skipAppLeave property - -if true, will bypass the default onAppLeave behavior - -Signature: - -```typescript -skipAppLeave?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md deleted file mode 100644 index ccb76f7bbf18e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [state](./kibana-plugin-core-public.navigatetoappoptions.state.md) - -## NavigateToAppOptions.state property - -optional state to forward to the application - -Signature: - -```typescript -state?: unknown; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md deleted file mode 100644 index a71196093a9a0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) > [forceRedirect](./kibana-plugin-core-public.navigatetourloptions.forceredirect.md) - -## NavigateToUrlOptions.forceRedirect property - -if true will force a full page reload/refresh/assign, overriding the outcome of other url checks against current the location (effectively using `window.location.assign` instead of `push`) - -Signature: - -```typescript -forceRedirect?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md deleted file mode 100644 index 2ee7b4f843c67..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) - -## NavigateToUrlOptions interface - -Options for the [navigateToUrl API](./kibana-plugin-core-public.applicationstart.navigatetourl.md) - -Signature: - -```typescript -export interface NavigateToUrlOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [forceRedirect?](./kibana-plugin-core-public.navigatetourloptions.forceredirect.md) | boolean | (Optional) if true will force a full page reload/refresh/assign, overriding the outcome of other url checks against current the location (effectively using window.location.assign instead of push) | -| [skipAppLeave?](./kibana-plugin-core-public.navigatetourloptions.skipappleave.md) | boolean | (Optional) if true, will bypass the default onAppLeave behavior | - diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md deleted file mode 100644 index f3685c02ff40d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) > [skipAppLeave](./kibana-plugin-core-public.navigatetourloptions.skipappleave.md) - -## NavigateToUrlOptions.skipAppLeave property - -if true, will bypass the default onAppLeave behavior - -Signature: - -```typescript -skipAppLeave?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navtype.md b/docs/development/core/public/kibana-plugin-core-public.navtype.md deleted file mode 100644 index 8f1d9a4351754..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavType](./kibana-plugin-core-public.navtype.md) - -## NavType type - -Signature: - -```typescript -export declare type NavType = 'modern' | 'legacy'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md deleted file mode 100644 index efaeafa1afb1a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) - -## NotificationsSetup interface - - -Signature: - -```typescript -export interface NotificationsSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) | ToastsSetup | [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md deleted file mode 100644 index f544ce98989b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) > [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) - -## NotificationsSetup.toasts property - -[ToastsSetup](./kibana-plugin-core-public.toastssetup.md) - -Signature: - -```typescript -toasts: ToastsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md deleted file mode 100644 index 0e77badd51235..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) - -## NotificationsStart interface - - -Signature: - -```typescript -export interface NotificationsStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) | ToastsStart | [ToastsStart](./kibana-plugin-core-public.toastsstart.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md deleted file mode 100644 index a047c66f04e71..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) > [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) - -## NotificationsStart.toasts property - -[ToastsStart](./kibana-plugin-core-public.toastsstart.md) - -Signature: - -```typescript -toasts: ToastsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md deleted file mode 100644 index fd3ce0b3a4292..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [add](./kibana-plugin-core-public.overlaybannersstart.add.md) - -## OverlayBannersStart.add() method - -Add a new banner - -Signature: - -```typescript -add(mount: MountPoint, priority?: number): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) | -| priority | number | optional priority order to display this banner. Higher priority values are shown first. | - -Returns: - -string - -a unique identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-core-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-core-public.overlaybannersstart.replace.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md deleted file mode 100644 index b5f0ab1d01299..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [getComponent](./kibana-plugin-core-public.overlaybannersstart.getcomponent.md) - -## OverlayBannersStart.getComponent() method - -Signature: - -```typescript -getComponent(): JSX.Element; -``` -Returns: - -JSX.Element - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md deleted file mode 100644 index f81da84d58bdc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) - -## OverlayBannersStart interface - - -Signature: - -```typescript -export interface OverlayBannersStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [add(mount, priority)](./kibana-plugin-core-public.overlaybannersstart.add.md) | Add a new banner | -| [getComponent()](./kibana-plugin-core-public.overlaybannersstart.getcomponent.md) | | -| [remove(id)](./kibana-plugin-core-public.overlaybannersstart.remove.md) | Remove a banner | -| [replace(id, mount, priority)](./kibana-plugin-core-public.overlaybannersstart.replace.md) | Replace a banner in place | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md deleted file mode 100644 index ce1e3ee08bd51..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [remove](./kibana-plugin-core-public.overlaybannersstart.remove.md) - -## OverlayBannersStart.remove() method - -Remove a banner - -Signature: - -```typescript -remove(id: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) | - -Returns: - -boolean - -if the banner was found or not - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md deleted file mode 100644 index ea16c739cc847..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [replace](./kibana-plugin-core-public.overlaybannersstart.replace.md) - -## OverlayBannersStart.replace() method - -Replace a banner in place - -Signature: - -```typescript -replace(id: string | undefined, mount: MountPoint, priority?: number): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string \| undefined | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) | -| priority | number | optional priority order to display this banner. Higher priority values are shown first. | - -Returns: - -string - -a new identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-core-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-core-public.overlaybannersstart.replace.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md deleted file mode 100644 index f135fa9618958..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > ["aria-label"](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) - -## OverlayFlyoutOpenOptions."aria-label" property - -Signature: - -```typescript -'aria-label'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md deleted file mode 100644 index d583aae0e0b19..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) - -## OverlayFlyoutOpenOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md deleted file mode 100644 index 26f6db77cccea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [className](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) - -## OverlayFlyoutOpenOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md deleted file mode 100644 index 44014b7f0d816..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) - -## OverlayFlyoutOpenOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md deleted file mode 100644 index 149a53f35d34d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [hideCloseButton](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) - -## OverlayFlyoutOpenOptions.hideCloseButton property - -Signature: - -```typescript -hideCloseButton?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md deleted file mode 100644 index 3cb3e0b4902a9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [maskProps](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md) - -## OverlayFlyoutOpenOptions.maskProps property - -Signature: - -```typescript -maskProps?: EuiOverlayMaskProps; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md deleted file mode 100644 index 4f582e746191f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [maxWidth](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) - -## OverlayFlyoutOpenOptions.maxWidth property - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md deleted file mode 100644 index 86117422e5faf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - -## OverlayFlyoutOpenOptions interface - - -Signature: - -```typescript -export interface OverlayFlyoutOpenOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["aria-label"?](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) | string | (Optional) | -| ["data-test-subj"?](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) | string | (Optional) | -| [hideCloseButton?](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) | boolean | (Optional) | -| [maskProps?](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md) | EuiOverlayMaskProps | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) | -| [onClose?](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) | (flyout: OverlayRef) => void | (Optional) EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; | -| [outsideClickCloses?](./kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md) | boolean | (Optional) | -| [ownFocus?](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) | boolean | (Optional) | -| [size?](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) | EuiFlyoutSize | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md deleted file mode 100644 index 5cfbba4c84a36..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [onClose](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) - -## OverlayFlyoutOpenOptions.onClose property - -EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; - -Signature: - -```typescript -onClose?: (flyout: OverlayRef) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md deleted file mode 100644 index acb9bac6f55da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [outsideClickCloses](./kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md) - -## OverlayFlyoutOpenOptions.outsideClickCloses property - -Signature: - -```typescript -outsideClickCloses?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md deleted file mode 100644 index 337ce2c48e1d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [ownFocus](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) - -## OverlayFlyoutOpenOptions.ownFocus property - -Signature: - -```typescript -ownFocus?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md deleted file mode 100644 index 3754242dc7c26..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [size](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) - -## OverlayFlyoutOpenOptions.size property - -Signature: - -```typescript -size?: EuiFlyoutSize; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md deleted file mode 100644 index 790fd57320413..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) - -## OverlayFlyoutStart interface - -APIs to open and manage fly-out dialogs. - -Signature: - -```typescript -export interface OverlayFlyoutStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [open(mount, options)](./kibana-plugin-core-public.overlayflyoutstart.open.md) | Opens a flyout panel with the given mount point inside. You can use close() on the returned FlyoutRef to close the flyout. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md deleted file mode 100644 index 94290eb91f942..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) > [open](./kibana-plugin-core-public.overlayflyoutstart.open.md) - -## OverlayFlyoutStart.open() method - -Opens a flyout panel with the given mount point inside. You can use `close()` on the returned FlyoutRef to close the flyout. - -Signature: - -```typescript -open(mount: MountPoint, options?: OverlayFlyoutOpenOptions): OverlayRef; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside a flyout panel | -| options | OverlayFlyoutOpenOptions | [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - options for the flyout [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened flyout panel. | - -Returns: - -OverlayRef - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md deleted file mode 100644 index 3569b2153c3da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) - -## OverlayModalConfirmOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md deleted file mode 100644 index 5c827e19e42e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [buttonColor](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) - -## OverlayModalConfirmOptions.buttonColor property - -Signature: - -```typescript -buttonColor?: EuiConfirmModalProps['buttonColor']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md deleted file mode 100644 index 0c0b9fd48dbd6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [cancelButtonText](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) - -## OverlayModalConfirmOptions.cancelButtonText property - -Signature: - -```typescript -cancelButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md deleted file mode 100644 index 0a622aeaac418..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [className](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) - -## OverlayModalConfirmOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md deleted file mode 100644 index 8a321a0b07b4c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) - -## OverlayModalConfirmOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md deleted file mode 100644 index f84d834369f5b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [confirmButtonText](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) - -## OverlayModalConfirmOptions.confirmButtonText property - -Signature: - -```typescript -confirmButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md deleted file mode 100644 index c5edf48b54ea8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [defaultFocusedButton](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) - -## OverlayModalConfirmOptions.defaultFocusedButton property - -Signature: - -```typescript -defaultFocusedButton?: EuiConfirmModalProps['defaultFocusedButton']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md deleted file mode 100644 index 488b4eb3794fb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [maxWidth](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) - -## OverlayModalConfirmOptions.maxWidth property - -Sets the max-width of the modal. Set to `true` to use the default (`euiBreakpoints 'm'`), set to `false` to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md deleted file mode 100644 index 2f672e551ba51..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) - -## OverlayModalConfirmOptions interface - - -Signature: - -```typescript -export interface OverlayModalConfirmOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) | string | (Optional) | -| [buttonColor?](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) | EuiConfirmModalProps\['buttonColor'\] | (Optional) | -| [cancelButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) | string | (Optional) | -| [confirmButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) | string | (Optional) | -| [defaultFocusedButton?](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) | EuiConfirmModalProps\['defaultFocusedButton'\] | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) | boolean \| number \| string | (Optional) Sets the max-width of the modal. Set to true to use the default (euiBreakpoints 'm'), set to false to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. | -| [title?](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md deleted file mode 100644 index cfbe41e0a7e9f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [title](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) - -## OverlayModalConfirmOptions.title property - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md deleted file mode 100644 index f0eba659dc62b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) - -## OverlayModalOpenOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md deleted file mode 100644 index 769387b8c35ff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [className](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) - -## OverlayModalOpenOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md deleted file mode 100644 index 4e685055b9e17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) - -## OverlayModalOpenOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md deleted file mode 100644 index 0ae888f9cb361..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [maxWidth](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) - -## OverlayModalOpenOptions.maxWidth property - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md deleted file mode 100644 index 5fc978ea26262..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - -## OverlayModalOpenOptions interface - - -Signature: - -```typescript -export interface OverlayModalOpenOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) | string | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md deleted file mode 100644 index 1d8fe1a92dd90..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) - -## OverlayModalStart interface - -APIs to open and manage modal dialogs. - -Signature: - -```typescript -export interface OverlayModalStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [open(mount, options)](./kibana-plugin-core-public.overlaymodalstart.open.md) | Opens a modal panel with the given mount point inside. You can use close() on the returned OverlayRef to close the modal. | -| [openConfirm(message, options)](./kibana-plugin-core-public.overlaymodalstart.openconfirm.md) | Opens a confirmation modal with the given text or mountpoint as a message. Returns a Promise resolving to true if user confirmed or false otherwise. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md deleted file mode 100644 index 35bfa406b4d17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) > [open](./kibana-plugin-core-public.overlaymodalstart.open.md) - -## OverlayModalStart.open() method - -Opens a modal panel with the given mount point inside. You can use `close()` on the returned OverlayRef to close the modal. - -Signature: - -```typescript -open(mount: MountPoint, options?: OverlayModalOpenOptions): OverlayRef; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside the modal | -| options | OverlayModalOpenOptions | [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - options for the modal [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened modal. | - -Returns: - -OverlayRef - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md deleted file mode 100644 index 056f512de87bf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) > [openConfirm](./kibana-plugin-core-public.overlaymodalstart.openconfirm.md) - -## OverlayModalStart.openConfirm() method - -Opens a confirmation modal with the given text or mountpoint as a message. Returns a Promise resolving to `true` if user confirmed or `false` otherwise. - -Signature: - -```typescript -openConfirm(message: MountPoint | string, options?: OverlayModalConfirmOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | MountPoint \| string | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - string or mountpoint to be used a the confirm message body | -| options | OverlayModalConfirmOptions | [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) - options for the confirm modal | - -Returns: - -Promise<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md deleted file mode 100644 index 454723f6ffd09..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) > [close](./kibana-plugin-core-public.overlayref.close.md) - -## OverlayRef.close() method - -Closes the referenced overlay if it's still open which in turn will resolve the `onClose` Promise. If the overlay had already been closed this method does nothing. - -Signature: - -```typescript -close(): Promise; -``` -Returns: - -Promise<void> - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.md deleted file mode 100644 index da11e284f285d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) - -## OverlayRef interface - -Returned by [OverlayStart](./kibana-plugin-core-public.overlaystart.md) methods for closing a mounted overlay. - -Signature: - -```typescript -export interface OverlayRef -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onClose](./kibana-plugin-core-public.overlayref.onclose.md) | Promise<void> | A Promise that will resolve once this overlay is closed.Overlays can close from user interaction, calling close() on the overlay reference or another overlay replacing yours via openModal or openFlyout. | - -## Methods - -| Method | Description | -| --- | --- | -| [close()](./kibana-plugin-core-public.overlayref.close.md) | Closes the referenced overlay if it's still open which in turn will resolve the onClose Promise. If the overlay had already been closed this method does nothing. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md deleted file mode 100644 index 3752c6ecf7de0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) > [onClose](./kibana-plugin-core-public.overlayref.onclose.md) - -## OverlayRef.onClose property - -A Promise that will resolve once this overlay is closed. - -Overlays can close from user interaction, calling `close()` on the overlay reference or another overlay replacing yours via `openModal` or `openFlyout`. - -Signature: - -```typescript -onClose: Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md deleted file mode 100644 index 2cb1565a4cfc4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [banners](./kibana-plugin-core-public.overlaystart.banners.md) - -## OverlayStart.banners property - -[OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) - -Signature: - -```typescript -banners: OverlayBannersStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.md deleted file mode 100644 index 3bbdd4ab9b918..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) - -## OverlayStart interface - - -Signature: - -```typescript -export interface OverlayStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [banners](./kibana-plugin-core-public.overlaystart.banners.md) | OverlayBannersStart | [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) | -| [openConfirm](./kibana-plugin-core-public.overlaystart.openconfirm.md) | OverlayModalStart\['openConfirm'\] | | -| [openFlyout](./kibana-plugin-core-public.overlaystart.openflyout.md) | OverlayFlyoutStart\['open'\] | | -| [openModal](./kibana-plugin-core-public.overlaystart.openmodal.md) | OverlayModalStart\['open'\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md deleted file mode 100644 index cfa27f4ea6f60..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openConfirm](./kibana-plugin-core-public.overlaystart.openconfirm.md) - -## OverlayStart.openConfirm property - - -Signature: - -```typescript -openConfirm: OverlayModalStart['openConfirm']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md deleted file mode 100644 index 8059918b0ec10..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openFlyout](./kibana-plugin-core-public.overlaystart.openflyout.md) - -## OverlayStart.openFlyout property - - -Signature: - -```typescript -openFlyout: OverlayFlyoutStart['open']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md deleted file mode 100644 index 5b55084c78727..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openModal](./kibana-plugin-core-public.overlaystart.openmodal.md) - -## OverlayStart.openModal property - - -Signature: - -```typescript -openModal: OverlayModalStart['open']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.md deleted file mode 100644 index da8cef9b83cc7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) - -## Plugin\_2 interface - -The interface that should be returned by a `PluginInitializer`. - -Signature: - -```typescript -export interface Plugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-public.plugin_2.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-public.plugin_2.start.md) | | -| [stop()?](./kibana-plugin-core-public.plugin_2.stop.md) | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md deleted file mode 100644 index 5ebb5a1a74811..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [setup](./kibana-plugin-core-public.plugin_2.setup.md) - -## Plugin\_2.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup<TPluginsStart, TStart> | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md deleted file mode 100644 index f4979ee033aac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [start](./kibana-plugin-core-public.plugin_2.start.md) - -## Plugin\_2.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md deleted file mode 100644 index 69532f2d0e09d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [stop](./kibana-plugin-core-public.plugin_2.stop.md) - -## Plugin\_2.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md deleted file mode 100644 index 1fcc2999dfd2e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) - -## PluginInitializer type - -The `plugin` export at the root of a plugin's `public` directory should conform to this interface. - -Signature: - -```typescript -export declare type PluginInitializer = (core: PluginInitializerContext) => Plugin; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md deleted file mode 100644 index 0f4d7df94a30e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [config](./kibana-plugin-core-public.plugininitializercontext.config.md) - -## PluginInitializerContext.config property - -Signature: - -```typescript -readonly config: { - get: () => T; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md deleted file mode 100644 index 532561eafc4d7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [env](./kibana-plugin-core-public.plugininitializercontext.env.md) - -## PluginInitializerContext.env property - -Signature: - -```typescript -readonly env: { - mode: Readonly; - packageInfo: Readonly; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md deleted file mode 100644 index 3304b4bf3def4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) - -## PluginInitializerContext interface - -The available core services passed to a `PluginInitializer` - -Signature: - -```typescript -export interface PluginInitializerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-public.plugininitializercontext.config.md) | { get: <T extends object = ConfigSchema>() => T; } | | -| [env](./kibana-plugin-core-public.plugininitializercontext.env.md) | { mode: Readonly<EnvironmentMode>; packageInfo: Readonly<PackageInfo>; } | | -| [opaqueId](./kibana-plugin-core-public.plugininitializercontext.opaqueid.md) | PluginOpaqueId | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md deleted file mode 100644 index 8ee0c3a415ee3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [opaqueId](./kibana-plugin-core-public.plugininitializercontext.opaqueid.md) - -## PluginInitializerContext.opaqueId property - -A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. - -Signature: - -```typescript -readonly opaqueId: PluginOpaqueId; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md b/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md deleted file mode 100644 index 40fd98687c619..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicAppDeepLinkInfo](./kibana-plugin-core-public.publicappdeeplinkinfo.md) - -## PublicAppDeepLinkInfo type - -Public information about a registered app's [deepLinks](./kibana-plugin-core-public.appdeeplink.md) - -Signature: - -```typescript -export declare type PublicAppDeepLinkInfo = Omit & { - deepLinks: PublicAppDeepLinkInfo[]; - keywords: string[]; - navLinkStatus: AppNavLinkStatus; - searchable: boolean; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md b/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md deleted file mode 100644 index 01d23ae47a0d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicAppInfo](./kibana-plugin-core-public.publicappinfo.md) - -## PublicAppInfo type - -Public information about a registered [application](./kibana-plugin-core-public.app.md) - -Signature: - -```typescript -export declare type PublicAppInfo = Omit & { - status: AppStatus; - navLinkStatus: AppNavLinkStatus; - appRoute: string; - keywords: string[]; - deepLinks: PublicAppDeepLinkInfo[]; - searchable: boolean; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md deleted file mode 100644 index 678a69289ff23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicUiSettingsParams](./kibana-plugin-core-public.publicuisettingsparams.md) - -## PublicUiSettingsParams type - -A sub-set of [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) exposed to the client-side. - -Signature: - -```typescript -export declare type PublicUiSettingsParams = Omit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md b/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md deleted file mode 100644 index 928bf8c07004e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolveDeprecationResponse](./kibana-plugin-core-public.resolvedeprecationresponse.md) - -## ResolveDeprecationResponse type - -Signature: - -```typescript -export declare type ResolveDeprecationResponse = { - status: 'ok'; -} | { - status: 'fail'; - reason: string; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md deleted file mode 100644 index fb6f98eda62d1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [alias\_purpose](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md) - -## ResolvedSimpleSavedObject.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: SavedObjectsResolveResponse['alias_purpose']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md deleted file mode 100644 index 0e82842ef749d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [alias\_target\_id](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md) - -## ResolvedSimpleSavedObject.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: SavedObjectsResolveResponse['alias_target_id']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md deleted file mode 100644 index 92ae014380f14..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) - -## ResolvedSimpleSavedObject interface - -This interface is a very simple wrapper for SavedObjects resolved from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). - -Signature: - -```typescript -export interface ResolvedSimpleSavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md) | SavedObjectsResolveResponse\['alias\_purpose'\] | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md) | SavedObjectsResolveResponse\['alias\_target\_id'\] | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) | SavedObjectsResolveResponse\['outcome'\] | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md) | SimpleSavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md deleted file mode 100644 index ceeef7706cc0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) - -## ResolvedSimpleSavedObject.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: SavedObjectsResolveResponse['outcome']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md deleted file mode 100644 index 7d90791a26fd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [saved\_object](./kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md) - -## ResolvedSimpleSavedObject.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SimpleSavedObject; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md deleted file mode 100644 index bf64b25c04f92..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [attributes](./kibana-plugin-core-public.responseerrorbody.attributes.md) - -## ResponseErrorBody.attributes property - -Signature: - -```typescript -attributes?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md deleted file mode 100644 index 5bc9103691014..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) - -## ResponseErrorBody interface - - -Signature: - -```typescript -export interface ResponseErrorBody -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes?](./kibana-plugin-core-public.responseerrorbody.attributes.md) | Record<string, unknown> | (Optional) | -| [message](./kibana-plugin-core-public.responseerrorbody.message.md) | string | | -| [statusCode](./kibana-plugin-core-public.responseerrorbody.statuscode.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md deleted file mode 100644 index a3355ddafde1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [message](./kibana-plugin-core-public.responseerrorbody.message.md) - -## ResponseErrorBody.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md deleted file mode 100644 index a342bb0187d72..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [statusCode](./kibana-plugin-core-public.responseerrorbody.statuscode.md) - -## ResponseErrorBody.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md deleted file mode 100644 index e8b1e0927baff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [attributes](./kibana-plugin-core-public.savedobject.attributes.md) - -## SavedObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md deleted file mode 100644 index 9060a5d6777fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobject.coremigrationversion.md) - -## SavedObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md deleted file mode 100644 index ab9a611fc3a5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [error](./kibana-plugin-core-public.savedobject.error.md) - -## SavedObject.error property - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md deleted file mode 100644 index 34387f24bfcef..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [id](./kibana-plugin-core-public.savedobject.id.md) - -## SavedObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.md deleted file mode 100644 index 283a960013305..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) - -## SavedObject interface - -Signature: - -```typescript -export interface SavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobject.attributes.md) | T | The data for a Saved Object is stored as an object in the attributes property. | -| [coreMigrationVersion?](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [error?](./kibana-plugin-core-public.savedobject.error.md) | SavedObjectError | (Optional) | -| [id](./kibana-plugin-core-public.savedobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [migrationVersion?](./kibana-plugin-core-public.savedobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [namespaces?](./kibana-plugin-core-public.savedobject.namespaces.md) | string\[\] | (Optional) Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [originId?](./kibana-plugin-core-public.savedobject.originid.md) | string | (Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. | -| [references](./kibana-plugin-core-public.savedobject.references.md) | SavedObjectReference\[\] | A reference to another saved object. | -| [type](./kibana-plugin-core-public.savedobject.type.md) | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. | -| [updated\_at?](./kibana-plugin-core-public.savedobject.updated_at.md) | string | (Optional) Timestamp of the last time this document had been updated. | -| [version?](./kibana-plugin-core-public.savedobject.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md deleted file mode 100644 index c13b6dc429208..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [migrationVersion](./kibana-plugin-core-public.savedobject.migrationversion.md) - -## SavedObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md deleted file mode 100644 index 3418b964ab2d7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [namespaces](./kibana-plugin-core-public.savedobject.namespaces.md) - -## SavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md deleted file mode 100644 index f5bab09b9bcc0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [originId](./kibana-plugin-core-public.savedobject.originid.md) - -## SavedObject.originId property - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md deleted file mode 100644 index 09f6b8fb12b42..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [references](./kibana-plugin-core-public.savedobject.references.md) - -## SavedObject.references property - -A reference to another saved object. - -Signature: - -```typescript -references: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md deleted file mode 100644 index ccaa1f1d5231c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [type](./kibana-plugin-core-public.savedobject.type.md) - -## SavedObject.type property - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md deleted file mode 100644 index 111d4b676f00a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [updated\_at](./kibana-plugin-core-public.savedobject.updated_at.md) - -## SavedObject.updated\_at property - -Timestamp of the last time this document had been updated. - -Signature: - -```typescript -updated_at?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md deleted file mode 100644 index 23b8b3f40da2a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [version](./kibana-plugin-core-public.savedobject.version.md) - -## SavedObject.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md deleted file mode 100644 index 2d7be060e28fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) - -## SavedObjectAttribute type - -Type definition for a Saved Object attribute value - -Signature: - -```typescript -export declare type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md deleted file mode 100644 index 0493f52b11425..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttributes](./kibana-plugin-core-public.savedobjectattributes.md) - -## SavedObjectAttributes interface - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -export interface SavedObjectAttributes -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md deleted file mode 100644 index 388cfac2d9c33..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttributeSingle](./kibana-plugin-core-public.savedobjectattributesingle.md) - -## SavedObjectAttributeSingle type - -Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) - -Signature: - -```typescript -export declare type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md deleted file mode 100644 index 87180a520090f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [error](./kibana-plugin-core-public.savedobjecterror.error.md) - -## SavedObjectError.error property - -Signature: - -```typescript -error: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md deleted file mode 100644 index f6e8874b212b0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) - -## SavedObjectError interface - -Signature: - -```typescript -export interface SavedObjectError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.savedobjecterror.error.md) | string | | -| [message](./kibana-plugin-core-public.savedobjecterror.message.md) | string | | -| [metadata?](./kibana-plugin-core-public.savedobjecterror.metadata.md) | Record<string, unknown> | (Optional) | -| [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md deleted file mode 100644 index 2a51d4d1a514d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [message](./kibana-plugin-core-public.savedobjecterror.message.md) - -## SavedObjectError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md deleted file mode 100644 index a2725f0206655..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [metadata](./kibana-plugin-core-public.savedobjecterror.metadata.md) - -## SavedObjectError.metadata property - -Signature: - -```typescript -metadata?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md deleted file mode 100644 index 75a57e98fece2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) - -## SavedObjectError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md deleted file mode 100644 index 91f0213f7e3f0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [id](./kibana-plugin-core-public.savedobjectreference.id.md) - -## SavedObjectReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md deleted file mode 100644 index e63ba254602db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) - -## SavedObjectReference interface - -A reference to another saved object. - -Signature: - -```typescript -export interface SavedObjectReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectreference.id.md) | string | | -| [name](./kibana-plugin-core-public.savedobjectreference.name.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectreference.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md deleted file mode 100644 index a5389047b5a4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [name](./kibana-plugin-core-public.savedobjectreference.name.md) - -## SavedObjectReference.name property - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md deleted file mode 100644 index 9547d52c404b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [type](./kibana-plugin-core-public.savedobjectreference.type.md) - -## SavedObjectReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md deleted file mode 100644 index 10e01d7e7a931..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [id](./kibana-plugin-core-public.savedobjectreferencewithcontext.id.md) - -## SavedObjectReferenceWithContext.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md deleted file mode 100644 index 722b11f0c7ba9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [inboundReferences](./kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md) - -## SavedObjectReferenceWithContext.inboundReferences property - -References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation - -Signature: - -```typescript -inboundReferences: Array<{ - type: string; - id: string; - name: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md deleted file mode 100644 index 8a4b378850764..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [isMissing](./kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md) - -## SavedObjectReferenceWithContext.isMissing property - -Whether or not this object or reference is missing - -Signature: - -```typescript -isMissing?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md deleted file mode 100644 index 2b43bafbede5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) - -## SavedObjectReferenceWithContext interface - -A returned input object or one of its references, with additional context. - -Signature: - -```typescript -export interface SavedObjectReferenceWithContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectreferencewithcontext.id.md) | string | The ID of the referenced object | -| [inboundReferences](./kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md) | Array<{ type: string; id: string; name: string; }> | References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation | -| [isMissing?](./kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md) | boolean | (Optional) Whether or not this object or reference is missing | -| [originId?](./kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md) | string | (Optional) The origin ID of the referenced object (if it has one) | -| [spaces](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [spacesWithMatchingAliases?](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) | string\[\] | (Optional) The space(s) that legacy URL aliases matching this type/id exist in | -| [spacesWithMatchingOrigins?](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) | string\[\] | (Optional) The space(s) that objects matching this origin exist in (including this one) | -| [type](./kibana-plugin-core-public.savedobjectreferencewithcontext.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md deleted file mode 100644 index 418041ea5df60..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [originId](./kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md) - -## SavedObjectReferenceWithContext.originId property - -The origin ID of the referenced object (if it has one) - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md deleted file mode 100644 index 9140e94721f1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spaces](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md) - -## SavedObjectReferenceWithContext.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md deleted file mode 100644 index 02b0c9c0949df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spacesWithMatchingAliases](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingAliases property - -The space(s) that legacy URL aliases matching this type/id exist in - -Signature: - -```typescript -spacesWithMatchingAliases?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md deleted file mode 100644 index 88a7ebb5f2234..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spacesWithMatchingOrigins](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingOrigins property - -The space(s) that objects matching this origin exist in (including this one) - -Signature: - -```typescript -spacesWithMatchingOrigins?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md deleted file mode 100644 index d2e341627153c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [type](./kibana-plugin-core-public.savedobjectreferencewithcontext.type.md) - -## SavedObjectReferenceWithContext.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md deleted file mode 100644 index f86d3b5afc04e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) - -## SavedObjectsBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md) | string | (Optional) Specify the namespace for this operation | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md deleted file mode 100644 index 5b394750d618c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) > [namespace](./kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md) - -## SavedObjectsBaseOptions.namespace property - -Specify the namespace for this operation - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md deleted file mode 100644 index 3926231db17b5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) - -## SavedObjectsBatchResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBatchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [savedObjects](./kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md) | Array<SimpleSavedObject<T>> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md deleted file mode 100644 index 53db81aaad89a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) > [savedObjects](./kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md) - -## SavedObjectsBatchResponse.savedObjects property - -Signature: - -```typescript -savedObjects: Array>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md deleted file mode 100644 index fea1505c9b6f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) > [attributes](./kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md) - -## SavedObjectsBulkCreateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md deleted file mode 100644 index f9ff61859b1a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) - -## SavedObjectsBulkCreateObject interface - -Signature: - -```typescript -export interface SavedObjectsBulkCreateObject extends SavedObjectsCreateOptions -``` -Extends: SavedObjectsCreateOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md) | T | | -| [type](./kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md deleted file mode 100644 index afadde06db494..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md) - -## SavedObjectsBulkCreateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md deleted file mode 100644 index ada12c064e0a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) - -## SavedObjectsBulkCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkCreateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [overwrite?](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md) | boolean | (Optional) If a document with the given id already exists, overwrite it's contents (default=false). | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md deleted file mode 100644 index 20d5f84b1cf33..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) > [overwrite](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md) - -## SavedObjectsBulkCreateOptions.overwrite property - -If a document with the given `id` already exists, overwrite it's contents (default=false). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md deleted file mode 100644 index 6a8fd52a4dc49..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) > [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) - -## SavedObjectsBulkResolveObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md deleted file mode 100644 index fbff3d3bd8f25..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) - -## SavedObjectsBulkResolveObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md deleted file mode 100644 index 09c7991012da8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) - -## SavedObjectsBulkResolveObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md deleted file mode 100644 index 311b1bf262875..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) - -## SavedObjectsBulkResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolved\_objects](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md) | Array<ResolvedSimpleSavedObject<T>> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md deleted file mode 100644 index e2bf3828841de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md) - -## SavedObjectsBulkResolveResponse.resolved\_objects property - -Signature: - -```typescript -resolved_objects: Array>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md deleted file mode 100644 index 1c124970287e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [attributes](./kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md) - -## SavedObjectsBulkUpdateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md deleted file mode 100644 index 4fad01d2f2641..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [id](./kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md) - -## SavedObjectsBulkUpdateObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md deleted file mode 100644 index f28d99cb110c6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) - -## SavedObjectsBulkUpdateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md) | T | | -| [id](./kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md) | string | | -| [references?](./kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md) | SavedObjectReference\[\] | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md) | string | | -| [version?](./kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md deleted file mode 100644 index 64b9b56a5c0d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [references](./kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md) - -## SavedObjectsBulkUpdateObject.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md deleted file mode 100644 index 2dd5a879491a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md) - -## SavedObjectsBulkUpdateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md deleted file mode 100644 index 18e4259e89b35..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [version](./kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md) - -## SavedObjectsBulkUpdateObject.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md deleted file mode 100644 index a2cdd3eb801e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) - -## SavedObjectsBulkUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md deleted file mode 100644 index a6c0e92098bdc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) > [namespace](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md) - -## SavedObjectsBulkUpdateOptions.namespace property - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md deleted file mode 100644 index 98c5e250644ff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkCreate](./kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md) - -## SavedObjectsClientContract.bulkCreate() method - -Creates multiple documents at once - -Signature: - -```typescript -bulkCreate(objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkCreateObject\[\] | | -| options | SavedObjectsBulkCreateOptions | | - -Returns: - -Promise<SavedObjectsBatchResponse<unknown>> - -The result of the create operation containing created saved objects. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md deleted file mode 100644 index b091f14308177..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkGet](./kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md) - -## SavedObjectsClientContract.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects: Array<{ - id: string; - type: string; - }>): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<{ id: string; type: string; }> | an array ids, or an array of objects containing id and optionally type | - -Returns: - -Promise<SavedObjectsBatchResponse<unknown>> - -The saved objects with the given type and ids requested - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md deleted file mode 100644 index cb67bdc19d23c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkResolve](./kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md) - -## SavedObjectsClientContract.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: Array<{ - id: string; - type: string; - }>): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<{ id: string; type: string; }> | an array of objects containing id, type | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -The bulk resolve result for the saved objects for the given types and ids. - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. The `resolve` method in the public client uses `bulkResolve` under the hood, so it behaves the same way. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md deleted file mode 100644 index 84c461708218c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkUpdate](./kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md) - -## SavedObjectsClientContract.bulkUpdate() method - -Update multiple documents at once - -Signature: - -```typescript -bulkUpdate(objects: SavedObjectsBulkUpdateObject[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkUpdateObject\[\] | \[{ type, id, attributes, options: { version, references } }\] | - -Returns: - -Promise<SavedObjectsBatchResponse<T>> - -The result of the update operation containing both failed and updated saved objects. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md deleted file mode 100644 index 76906c0dba8d5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [create](./kibana-plugin-core-public.savedobjectsclientcontract.create.md) - -## SavedObjectsClientContract.create() method - -Persists an object - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SimpleSavedObject<T>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md deleted file mode 100644 index 39aee28ee7e01..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [delete](./kibana-plugin-core-public.savedobjectsclientcontract.delete.md) - -## SavedObjectsClientContract.delete() method - -Deletes an object - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | | - -Returns: - -Promise<{}> - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md deleted file mode 100644 index 8173773e461f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [find](./kibana-plugin-core-public.savedobjectsclientcontract.find.md) - -## SavedObjectsClientContract.find() method - -Search for objects - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | {string} options.type {string} options.search {string} options.searchFields - see Elasticsearch Simple Query String Query field argument for more information {integer} \[options.page=1\] {integer} \[options.perPage=20\] {array} options.fields {object} \[options.hasReference\] - { type, id } | - -Returns: - -Promise<SavedObjectsFindResponsePublic<T>> - -A find result with objects matching the specified search. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md deleted file mode 100644 index 4184e0a16ab5e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [get](./kibana-plugin-core-public.savedobjectsclientcontract.get.md) - -## SavedObjectsClientContract.get() method - -Fetches a single object - -Signature: - -```typescript -get(type: string, id: string): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -Promise<SimpleSavedObject<T>> - -The saved object for the given type and id. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md deleted file mode 100644 index bdc76b58f8dc2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) - -## SavedObjectsClientContract interface - -The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. - -Signature: - -```typescript -export interface SavedObjectsClientContract -``` - -## Methods - -| Method | Description | -| --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md) | Creates multiple documents at once | -| [bulkGet(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md) | Returns an array of objects by id | -| [bulkResolve(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md) | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md) | Update multiple documents at once | -| [create(type, attributes, options)](./kibana-plugin-core-public.savedobjectsclientcontract.create.md) | Persists an object | -| [delete(type, id, options)](./kibana-plugin-core-public.savedobjectsclientcontract.delete.md) | Deletes an object | -| [find(options)](./kibana-plugin-core-public.savedobjectsclientcontract.find.md) | Search for objects | -| [get(type, id)](./kibana-plugin-core-public.savedobjectsclientcontract.get.md) | Fetches a single object | -| [resolve(type, id)](./kibana-plugin-core-public.savedobjectsclientcontract.resolve.md) | Resolves a single object | -| [update(type, id, attributes, options)](./kibana-plugin-core-public.savedobjectsclientcontract.update.md) | Updates an object | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md deleted file mode 100644 index 6e9c9a1c9c945..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [resolve](./kibana-plugin-core-public.savedobjectsclientcontract.resolve.md) - -## SavedObjectsClientContract.resolve() method - -Resolves a single object - -Signature: - -```typescript -resolve(type: string, id: string): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -Promise<ResolvedSimpleSavedObject<T>> - -The resolve result for the saved object for the given type and id. - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior for the `resolve` API is unique to the public client, which batches individual calls with `bulkResolve` under the hood. We don't throw an error in that case for legacy compatibility reasons. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md deleted file mode 100644 index 0652404b91ad4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [update](./kibana-plugin-core-public.savedobjectsclientcontract.update.md) - -## SavedObjectsClientContract.update() method - -Updates an object - -Signature: - -```typescript -update(type: string, id: string, attributes: T, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | T | | -| options | SavedObjectsUpdateOptions | {integer} options.version - ensures version matches that of persisted object {object} options.migrationVersion - The optional migrationVersion of this document | - -Returns: - -Promise<SimpleSavedObject<T>> - - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md deleted file mode 100644 index a356850fa1ad4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse interface - -The response when object references are collected. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md) | SavedObjectReferenceWithContext\[\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md deleted file mode 100644 index 66a7a19d18288..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) > [objects](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectReferenceWithContext[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md deleted file mode 100644 index 3c1d068f458bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) - -## SavedObjectsCreateOptions.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md deleted file mode 100644 index 14e64cc9b7b34..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [id](./kibana-plugin-core-public.savedobjectscreateoptions.id.md) - -## SavedObjectsCreateOptions.id property - -(Not recommended) Specify an id instead of having the saved objects service generate one for you. - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md deleted file mode 100644 index 835a9e87a1dba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) - -## SavedObjectsCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsCreateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [coreMigrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [id?](./kibana-plugin-core-public.savedobjectscreateoptions.id.md) | string | (Optional) (Not recommended) Specify an id instead of having the saved objects service generate one for you. | -| [migrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [overwrite?](./kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md) | boolean | (Optional) If a document with the given id already exists, overwrite it's contents (default=false). | -| [references?](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) | SavedObjectReference\[\] | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md deleted file mode 100644 index 4ea4386303a58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [migrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md) - -## SavedObjectsCreateOptions.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md deleted file mode 100644 index aa3e102e6c042..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [overwrite](./kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md) - -## SavedObjectsCreateOptions.overwrite property - -If a document with the given `id` already exists, overwrite it's contents (default=false). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md deleted file mode 100644 index ef67cdb771630..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [references](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) - -## SavedObjectsCreateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md deleted file mode 100644 index f1c2fd08a21f1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [defaultSearchOperator](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) - -## SavedObjectsFindOptions.defaultSearchOperator property - -The search operator to use with the provided filter. Defaults to `OR` - -Signature: - -```typescript -defaultSearchOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md deleted file mode 100644 index 39bc1d3161bd4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [fields](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) - -## SavedObjectsFindOptions.fields property - -An array of fields to include in the results - -Signature: - -```typescript -fields?: string[]; -``` - -## Example - -SavedObjects.find({type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]}) - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md deleted file mode 100644 index 2c20fe2dab00f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [filter](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) - -## SavedObjectsFindOptions.filter property - -Signature: - -```typescript -filter?: string | KueryNode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md deleted file mode 100644 index 25ce8fa7b6018..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [hasReference](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) - -## SavedObjectsFindOptions.hasReference property - -Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md deleted file mode 100644 index 3681d1c9d34d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [hasReferenceOperator](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) - -## SavedObjectsFindOptions.hasReferenceOperator property - -The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - -Signature: - -```typescript -hasReferenceOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md deleted file mode 100644 index 98ac48f6cdbd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) - -## SavedObjectsFindOptions interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | 'AND' \| 'OR' | (Optional) The search operator to use with the provided filter. Defaults to OR | -| [fields?](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) | string\[\] | (Optional) An array of fields to include in the results | -| [filter?](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) | string \| KueryNode | (Optional) | -| [hasReference?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | (Optional) Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. | -| [hasReferenceOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) | 'AND' \| 'OR' | (Optional) The operator to use when searching by multiple references using the hasReference option. Defaults to OR | -| [namespaces?](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) | string\[\] | (Optional) | -| [page?](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | number | (Optional) | -| [perPage?](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | number | (Optional) | -| [pit?](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) | SavedObjectsPitParams | (Optional) Search against a specific Point In Time (PIT) that you've opened with . | -| [preference?](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query \* | -| [rootSearchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. | -| [search?](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) | string | (Optional) Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information | -| [searchAfter?](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) | estypes.Id\[\] | (Optional) Use the sort values from the previous page to retrieve the next page of results. | -| [searchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information | -| [sortField?](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) | string | (Optional) | -| [sortOrder?](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) | estypes.SortOrder | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) | string \| string\[\] | | -| [typeToNamespacesMap?](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) | Map<string, string\[\] \| undefined> | (Optional) This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md deleted file mode 100644 index 9cc9d64db1f65..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [namespaces](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) - -## SavedObjectsFindOptions.namespaces property - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md deleted file mode 100644 index e009a4ac8e393..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [page](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) - -## SavedObjectsFindOptions.page property - -Signature: - -```typescript -page?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md deleted file mode 100644 index 0c6f3464d194c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [perPage](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) - -## SavedObjectsFindOptions.perPage property - -Signature: - -```typescript -perPage?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md deleted file mode 100644 index 2284a4d8d210d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [pit](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) - -## SavedObjectsFindOptions.pit property - -Search against a specific Point In Time (PIT) that you've opened with . - -Signature: - -```typescript -pit?: SavedObjectsPitParams; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md deleted file mode 100644 index 8a30cb99c57bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [preference](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) - -## SavedObjectsFindOptions.preference property - -An optional ES preference value to be used for the query \* - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md deleted file mode 100644 index faa971509eca2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [rootSearchFields](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) - -## SavedObjectsFindOptions.rootSearchFields property - -The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not be modified. If used in conjunction with `searchFields`, both are concatenated together. - -Signature: - -```typescript -rootSearchFields?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md deleted file mode 100644 index a7d149b58be02..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [search](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) - -## SavedObjectsFindOptions.search property - -Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md deleted file mode 100644 index 7016e1f1b72de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [searchAfter](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) - -## SavedObjectsFindOptions.searchAfter property - -Use the sort values from the previous page to retrieve the next page of results. - -Signature: - -```typescript -searchAfter?: estypes.Id[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md deleted file mode 100644 index c99864ac8c046..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [searchFields](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) - -## SavedObjectsFindOptions.searchFields property - -The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information - -Signature: - -```typescript -searchFields?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md deleted file mode 100644 index 7b5072c0e19df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [sortField](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) - -## SavedObjectsFindOptions.sortField property - -Signature: - -```typescript -sortField?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md deleted file mode 100644 index 36f99e51ea8c6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [sortOrder](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) - -## SavedObjectsFindOptions.sortOrder property - -Signature: - -```typescript -sortOrder?: estypes.SortOrder; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md deleted file mode 100644 index b4ce216fab1ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) - -## SavedObjectsFindOptions.type property - -Signature: - -```typescript -type: string | string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md deleted file mode 100644 index 4af8c9ddeaff4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [typeToNamespacesMap](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) - -## SavedObjectsFindOptions.typeToNamespacesMap property - -This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. - -Signature: - -```typescript -typeToNamespacesMap?: Map; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md deleted file mode 100644 index 5e4c8dd982a0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) > [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md) - -## SavedObjectsFindOptionsReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md deleted file mode 100644 index cab03bf71393c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) - -## SavedObjectsFindOptionsReference interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptionsReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md deleted file mode 100644 index 3779bfd204a4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) > [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md) - -## SavedObjectsFindOptionsReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md deleted file mode 100644 index 14401b02f25c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [aggregations](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md) - -## SavedObjectsFindResponsePublic.aggregations property - -Signature: - -```typescript -aggregations?: A; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md deleted file mode 100644 index dd26960a95766..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) - -## SavedObjectsFindResponsePublic interface - -Return type of the Saved Objects `find()` method. - -\*Note\*: this type is different between the Public and Server Saved Objects clients. - -Signature: - -```typescript -export interface SavedObjectsFindResponsePublic extends SavedObjectsBatchResponse -``` -Extends: SavedObjectsBatchResponse<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aggregations?](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md) | A | (Optional) | -| [page](./kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md) | number | | -| [perPage](./kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md) | number | | -| [total](./kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md deleted file mode 100644 index 77b59c8012a5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [page](./kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md) - -## SavedObjectsFindResponsePublic.page property - -Signature: - -```typescript -page: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md deleted file mode 100644 index b6c6f1a6bff47..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [perPage](./kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md) - -## SavedObjectsFindResponsePublic.perPage property - -Signature: - -```typescript -perPage: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md deleted file mode 100644 index ea551d6be0d7e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [total](./kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md) - -## SavedObjectsFindResponsePublic.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md deleted file mode 100644 index 8752120b27c87..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) - -## SavedObjectsImportActionRequiredWarning.actionPath property - -The path (without the basePath) that the user should be redirect to address this warning. - -Signature: - -```typescript -actionPath: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md deleted file mode 100644 index ae7daba4860ef..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [buttonLabel](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md) - -## SavedObjectsImportActionRequiredWarning.buttonLabel property - -An optional label to use for the link button. If unspecified, a default label will be used. - -Signature: - -```typescript -buttonLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md deleted file mode 100644 index fe148fdc2ff1a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) - -## SavedObjectsImportActionRequiredWarning interface - -A warning meant to notify that a specific user action is required to finalize the import of some type of object. - - The `actionUrl` must be a path relative to the basePath, and not include it. - -Signature: - -```typescript -export interface SavedObjectsImportActionRequiredWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) | string | The path (without the basePath) that the user should be redirect to address this warning. | -| [buttonLabel?](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md) | string | (Optional) An optional label to use for the link button. If unspecified, a default label will be used. | -| [message](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md) | string | The translated message to display to the user. | -| [type](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md) | 'action\_required' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md deleted file mode 100644 index c0f322892577e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [message](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md) - -## SavedObjectsImportActionRequiredWarning.message property - -The translated message to display to the user. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md deleted file mode 100644 index ee88f6a0d5d85..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [type](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md) - -## SavedObjectsImportActionRequiredWarning.type property - -Signature: - -```typescript -type: 'action_required'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md deleted file mode 100644 index 59ce43c4bea62..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) > [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md) - -## SavedObjectsImportAmbiguousConflictError.destinations property - -Signature: - -```typescript -destinations: Array<{ - id: string; - title?: string; - updatedAt?: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md deleted file mode 100644 index 2d136bb870de7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) - -## SavedObjectsImportAmbiguousConflictError interface - -Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. - -Signature: - -```typescript -export interface SavedObjectsImportAmbiguousConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md) | Array<{ id: string; title?: string; updatedAt?: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md) | 'ambiguous\_conflict' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md deleted file mode 100644 index 600c56988ac75..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) > [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md) - -## SavedObjectsImportAmbiguousConflictError.type property - -Signature: - -```typescript -type: 'ambiguous_conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md deleted file mode 100644 index ba4002d932f57..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md) - -## SavedObjectsImportConflictError.destinationId property - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md deleted file mode 100644 index 57737986ba4ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) - -## SavedObjectsImportConflictError interface - -Represents a failure to import due to a conflict. - -Signature: - -```typescript -export interface SavedObjectsImportConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md) | string | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsimportconflicterror.type.md) | 'conflict' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md deleted file mode 100644 index 651e230e6de8a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) > [type](./kibana-plugin-core-public.savedobjectsimportconflicterror.type.md) - -## SavedObjectsImportConflictError.type property - -Signature: - -```typescript -type: 'conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md deleted file mode 100644 index 16628e83b8af9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [error](./kibana-plugin-core-public.savedobjectsimportfailure.error.md) - -## SavedObjectsImportFailure.error property - -Signature: - -```typescript -error: SavedObjectsImportConflictError | SavedObjectsImportAmbiguousConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md deleted file mode 100644 index 2279241083241..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [id](./kibana-plugin-core-public.savedobjectsimportfailure.id.md) - -## SavedObjectsImportFailure.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md deleted file mode 100644 index e7de1014bdaf2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) - -## SavedObjectsImportFailure interface - -Represents a failure to import. - -Signature: - -```typescript -export interface SavedObjectsImportFailure -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.savedobjectsimportfailure.error.md) | SavedObjectsImportConflictError \| SavedObjectsImportAmbiguousConflictError \| SavedObjectsImportUnsupportedTypeError \| SavedObjectsImportMissingReferencesError \| SavedObjectsImportUnknownError | | -| [id](./kibana-plugin-core-public.savedobjectsimportfailure.id.md) | string | | -| [meta](./kibana-plugin-core-public.savedobjectsimportfailure.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md) | boolean | (Optional) If overwrite is specified, an attempt was made to overwrite an existing object. | -| [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md deleted file mode 100644 index 4ea9455098035..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [meta](./kibana-plugin-core-public.savedobjectsimportfailure.meta.md) - -## SavedObjectsImportFailure.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md deleted file mode 100644 index 579a16697b406..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md) - -## SavedObjectsImportFailure.overwrite property - -If `overwrite` is specified, an attempt was made to overwrite an existing object. - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md deleted file mode 100644 index 68411093a92ce..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) - -## SavedObjectsImportFailure.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md deleted file mode 100644 index 6c03ab263084c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) - -## SavedObjectsImportMissingReferencesError interface - -Represents a failure to import due to missing references. - -Signature: - -```typescript -export interface SavedObjectsImportMissingReferencesError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) | Array<{ type: string; id: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) | 'missing\_references' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md deleted file mode 100644 index b479956ed7125..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) > [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) - -## SavedObjectsImportMissingReferencesError.references property - -Signature: - -```typescript -references: Array<{ - type: string; - id: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md deleted file mode 100644 index 6c0caa258c5fb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) > [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) - -## SavedObjectsImportMissingReferencesError.type property - -Signature: - -```typescript -type: 'missing_references'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md deleted file mode 100644 index 073eac20b04ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [errors](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) - -## SavedObjectsImportResponse.errors property - -Signature: - -```typescript -errors?: SavedObjectsImportFailure[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md deleted file mode 100644 index 5b6139723a101..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) - -## SavedObjectsImportResponse interface - -The response describing the result of an import. - -Signature: - -```typescript -export interface SavedObjectsImportResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors?](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) | SavedObjectsImportFailure\[\] | (Optional) | -| [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) | boolean | | -| [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) | number | | -| [successResults?](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) | SavedObjectsImportSuccess\[\] | (Optional) | -| [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) | SavedObjectsImportWarning\[\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md deleted file mode 100644 index 3c6492f340418..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) - -## SavedObjectsImportResponse.success property - -Signature: - -```typescript -success: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md deleted file mode 100644 index caa296c3ef291..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) - -## SavedObjectsImportResponse.successCount property - -Signature: - -```typescript -successCount: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md deleted file mode 100644 index 51a47b6c2d953..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [successResults](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) - -## SavedObjectsImportResponse.successResults property - -Signature: - -```typescript -successResults?: SavedObjectsImportSuccess[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md deleted file mode 100644 index 2e55a2e30f9cb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) - -## SavedObjectsImportResponse.warnings property - -Signature: - -```typescript -warnings: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md deleted file mode 100644 index f60c713973d58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [createNewCopy](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) - -## SavedObjectsImportRetry.createNewCopy property - -If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md deleted file mode 100644 index 5131d1d01ff02..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) - -## SavedObjectsImportRetry.destinationId property - -The object ID that will be created or overwritten. If not specified, the `id` field will be used. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md deleted file mode 100644 index 961c61a2cba6c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) - -## SavedObjectsImportRetry.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md deleted file mode 100644 index 4ce833f2966cc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [ignoreMissingReferences](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) - -## SavedObjectsImportRetry.ignoreMissingReferences property - -If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. - -Signature: - -```typescript -ignoreMissingReferences?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md deleted file mode 100644 index 80a3145ae7e55..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) - -## SavedObjectsImportRetry interface - -Describes a retry operation for importing a saved object. - -Signature: - -```typescript -export interface SavedObjectsImportRetry -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) | boolean | (Optional) If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) | string | (Optional) The object ID that will be created or overwritten. If not specified, the id field will be used. | -| [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) | string | | -| [ignoreMissingReferences?](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) | boolean | (Optional) If ignoreMissingReferences is specified, reference validation will be skipped for this object. | -| [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | boolean | | -| [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) | Array<{ type: string; from: string; to: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md deleted file mode 100644 index 51ea151a9cdb3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) - -## SavedObjectsImportRetry.overwrite property - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md deleted file mode 100644 index 2b0fd703c0d81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) - -## SavedObjectsImportRetry.replaceReferences property - -Signature: - -```typescript -replaceReferences: Array<{ - type: string; - from: string; - to: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md deleted file mode 100644 index 86ccd13d7ff55..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) - -## SavedObjectsImportRetry.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md deleted file mode 100644 index 304779a1589f9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) - -## SavedObjectsImportSimpleWarning interface - -A simple informative warning that will be displayed to the user. - -Signature: - -```typescript -export interface SavedObjectsImportSimpleWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) | string | The translated message to display to the user | -| [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) | 'simple' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md deleted file mode 100644 index 42c94e14e3d28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) > [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) - -## SavedObjectsImportSimpleWarning.message property - -The translated message to display to the user - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md deleted file mode 100644 index 86a4cbfa434e7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) > [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) - -## SavedObjectsImportSimpleWarning.type property - -Signature: - -```typescript -type: 'simple'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md deleted file mode 100644 index 8867331c1e4b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [createNewCopy](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) - -## SavedObjectsImportSuccess.createNewCopy property - -> Warning: This API is now obsolete. -> -> Can be removed when https://github.com/elastic/kibana/issues/91615 is done. If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, this field will be redundant and can be removed. -> - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md deleted file mode 100644 index 55611a77aeb67..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) - -## SavedObjectsImportSuccess.destinationId property - -If `destinationId` is specified, the new object has a new ID that is different from the import ID. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md deleted file mode 100644 index 6d6271e37dffe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) - -## SavedObjectsImportSuccess.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md deleted file mode 100644 index 57ca4b7a787f6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) - -## SavedObjectsImportSuccess interface - -Represents a successful import. - -Signature: - -```typescript -export interface SavedObjectsImportSuccess -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) | boolean | (Optional) | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) | string | (Optional) If destinationId is specified, the new object has a new ID that is different from the import ID. | -| [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) | string | | -| [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) | boolean | (Optional) If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). | -| [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md deleted file mode 100644 index d1c7bc92b5cbf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) - -## SavedObjectsImportSuccess.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md deleted file mode 100644 index 18ae2ca9bee3d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) - -## SavedObjectsImportSuccess.overwrite property - -If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md deleted file mode 100644 index 6ac14455d281f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) - -## SavedObjectsImportSuccess.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md deleted file mode 100644 index fc78e04dee8ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) - -## SavedObjectsImportUnknownError interface - -Represents a failure to import due to an unknown reason. - -Signature: - -```typescript -export interface SavedObjectsImportUnknownError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) | string | | -| [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) | number | | -| [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) | 'unknown' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md deleted file mode 100644 index 4445b3527657f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) - -## SavedObjectsImportUnknownError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md deleted file mode 100644 index 929631cf84b2e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) - -## SavedObjectsImportUnknownError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md deleted file mode 100644 index 9febc279bb093..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) - -## SavedObjectsImportUnknownError.type property - -Signature: - -```typescript -type: 'unknown'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md deleted file mode 100644 index de805f05a12e9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) - -## SavedObjectsImportUnsupportedTypeError interface - -Represents a failure to import due to having an unsupported saved object type. - -Signature: - -```typescript -export interface SavedObjectsImportUnsupportedTypeError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) | 'unsupported\_type' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md deleted file mode 100644 index ca8c2a419095f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) > [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) - -## SavedObjectsImportUnsupportedTypeError.type property - -Signature: - -```typescript -type: 'unsupported_type'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md deleted file mode 100644 index a9a9a70774970..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) - -## SavedObjectsImportWarning type - -Composite type of all the possible types of import warnings. - -See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details. - -Signature: - -```typescript -export declare type SavedObjectsImportWarning = SavedObjectsImportSimpleWarning | SavedObjectsImportActionRequiredWarning; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md deleted file mode 100644 index f1132b98bc84e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsMigrationVersion](./kibana-plugin-core-public.savedobjectsmigrationversion.md) - -## SavedObjectsMigrationVersion interface - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -export interface SavedObjectsMigrationVersion -``` - -## Example - -migrationVersion: { dashboard: '7.1.1', space: '6.6.6', } - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md deleted file mode 100644 index cf5e6cb29a532..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsNamespaceType](./kibana-plugin-core-public.savedobjectsnamespacetype.md) - -## SavedObjectsNamespaceType type - -The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. - -Signature: - -```typescript -export declare type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md deleted file mode 100644 index 5e56fe402b10b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [alias\_purpose](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md) - -## SavedObjectsResolveResponse.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md deleted file mode 100644 index 534c5ffde730b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [alias\_target\_id](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md) - -## SavedObjectsResolveResponse.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md deleted file mode 100644 index e212b1ea8b002..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) - -## SavedObjectsResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md) | 'savedObjectConversion' \| 'savedObjectImport' | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md) | string | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) | SavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md deleted file mode 100644 index ff4367d804e5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) - -## SavedObjectsResolveResponse.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md deleted file mode 100644 index d8a74d766d582..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) - -## SavedObjectsResolveResponse.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SavedObject; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md deleted file mode 100644 index 4dc8c5ae41dbc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) > [client](./kibana-plugin-core-public.savedobjectsstart.client.md) - -## SavedObjectsStart.client property - -[SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) - -Signature: - -```typescript -client: SavedObjectsClientContract; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md deleted file mode 100644 index 774ef2a35a833..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) - -## SavedObjectsStart interface - - -Signature: - -```typescript -export interface SavedObjectsStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-public.savedobjectsstart.client.md) | SavedObjectsClientContract | [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md deleted file mode 100644 index 4a9b85e7b67e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) - -## SavedObjectsUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references?](./kibana-plugin-core-public.savedobjectsupdateoptions.references.md) | SavedObjectReference\[\] | (Optional) | -| [upsert?](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md) | Attributes | (Optional) | -| [version?](./kibana-plugin-core-public.savedobjectsupdateoptions.version.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md deleted file mode 100644 index 87bd774a062a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [references](./kibana-plugin-core-public.savedobjectsupdateoptions.references.md) - -## SavedObjectsUpdateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md deleted file mode 100644 index 611fd54a527fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [upsert](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md) - -## SavedObjectsUpdateOptions.upsert property - -Signature: - -```typescript -upsert?: Attributes; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md deleted file mode 100644 index d3d90b0c443da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [version](./kibana-plugin-core-public.savedobjectsupdateoptions.version.md) - -## SavedObjectsUpdateOptions.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md deleted file mode 100644 index 67264a26ac5db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [(constructor)](./kibana-plugin-core-public.scopedhistory._constructor_.md) - -## ScopedHistory.(constructor) - -Constructs a new instance of the `ScopedHistory` class - -Signature: - -```typescript -constructor(parentHistory: History, basePath: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| parentHistory | History<HistoryLocationState> | | -| basePath | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md deleted file mode 100644 index 40971b6617dce..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [action](./kibana-plugin-core-public.scopedhistory.action.md) - -## ScopedHistory.action property - -The last action dispatched on the history stack. - -Signature: - -```typescript -get action(): Action; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md deleted file mode 100644 index acbb06c6aa6ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [block](./kibana-plugin-core-public.scopedhistory.block.md) - -## ScopedHistory.block property - -Add a block prompt requesting user confirmation when navigating away from the current page. - -Signature: - -```typescript -block: (prompt?: string | boolean | TransitionPromptHook | undefined) => UnregisterCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md deleted file mode 100644 index 5ab31c0ba6ff2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) - -## ScopedHistory.createHref property - -Creates an href (string) to the location. If `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath. - -Signature: - -```typescript -createHref: (location: LocationDescriptorObject, { prependBasePath }?: { - prependBasePath?: boolean | undefined; - }) => Href; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md deleted file mode 100644 index 7c5dfccb5b008..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) - -## ScopedHistory.createSubHistory property - -Creates a `ScopedHistory` for a subpath of this `ScopedHistory`. Useful for applications that may have sub-apps that do not need access to the containing application's history. - -Signature: - -```typescript -createSubHistory: (basePath: string) => ScopedHistory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md deleted file mode 100644 index 33d3e94c9171d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [go](./kibana-plugin-core-public.scopedhistory.go.md) - -## ScopedHistory.go property - -Send the user forward or backwards in the history stack. - -Signature: - -```typescript -go: (n: number) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md deleted file mode 100644 index ba32ac45d4b5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) - -## ScopedHistory.goBack property - -Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available backwards, this is a no-op. - -Signature: - -```typescript -goBack: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md deleted file mode 100644 index 9918cb0407cd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [goForward](./kibana-plugin-core-public.scopedhistory.goforward.md) - -## ScopedHistory.goForward property - -Send the user one location forward in the history stack. Equivalent to calling [ScopedHistory.go(1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available forwards, this is a no-op. - -Signature: - -```typescript -goForward: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md deleted file mode 100644 index 0205261b57539..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [length](./kibana-plugin-core-public.scopedhistory.length.md) - -## ScopedHistory.length property - -The number of entries in the history stack, including all entries forwards and backwards from the current location. - -Signature: - -```typescript -get length(): number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md deleted file mode 100644 index febf88639b67c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [listen](./kibana-plugin-core-public.scopedhistory.listen.md) - -## ScopedHistory.listen property - -Adds a listener for location updates. - -Signature: - -```typescript -listen: (listener: (location: Location, action: Action) => void) => UnregisterCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md deleted file mode 100644 index 45227a2b15ad0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [location](./kibana-plugin-core-public.scopedhistory.location.md) - -## ScopedHistory.location property - -The current location of the history stack. - -Signature: - -```typescript -get location(): Location; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md deleted file mode 100644 index a3c369b143b4a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md +++ /dev/null @@ -1,42 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) - -## ScopedHistory class - -A wrapper around a `History` instance that is scoped to a particular base path of the history stack. Behaves similarly to the `basename` option except that this wrapper hides any history stack entries from outside the scope of this base path. - -This wrapper also allows Core and Plugins to share a single underlying global `History` instance without exposing the history of other applications. - -The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. - -Signature: - -```typescript -export declare class ScopedHistory implements History -``` -Implements: History<HistoryLocationState> - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(parentHistory, basePath)](./kibana-plugin-core-public.scopedhistory._constructor_.md) | | Constructs a new instance of the ScopedHistory class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [action](./kibana-plugin-core-public.scopedhistory.action.md) | | Action | The last action dispatched on the history stack. | -| [block](./kibana-plugin-core-public.scopedhistory.block.md) | | (prompt?: string \| boolean \| TransitionPromptHook<HistoryLocationState> \| undefined) => UnregisterCallback | Add a block prompt requesting user confirmation when navigating away from the current page. | -| [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) | | (location: LocationDescriptorObject<HistoryLocationState>, { prependBasePath }?: { prependBasePath?: boolean \| undefined; }) => Href | Creates an href (string) to the location. If prependBasePath is true (default), it will prepend the location's path with the scoped history basePath. | -| [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) | | (basePath: string) => ScopedHistory<HistoryLocationState> | Creates a ScopedHistory for a subpath of this ScopedHistory. Useful for applications that may have sub-apps that do not need access to the containing application's history. | -| [go](./kibana-plugin-core-public.scopedhistory.go.md) | | (n: number) => void | Send the user forward or backwards in the history stack. | -| [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) | | () => void | Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available backwards, this is a no-op. | -| [goForward](./kibana-plugin-core-public.scopedhistory.goforward.md) | | () => void | Send the user one location forward in the history stack. Equivalent to calling [ScopedHistory.go(1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available forwards, this is a no-op. | -| [length](./kibana-plugin-core-public.scopedhistory.length.md) | | number | The number of entries in the history stack, including all entries forwards and backwards from the current location. | -| [listen](./kibana-plugin-core-public.scopedhistory.listen.md) | | (listener: (location: Location<HistoryLocationState>, action: Action) => void) => UnregisterCallback | Adds a listener for location updates. | -| [location](./kibana-plugin-core-public.scopedhistory.location.md) | | Location<HistoryLocationState> | The current location of the history stack. | -| [push](./kibana-plugin-core-public.scopedhistory.push.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. | -| [replace](./kibana-plugin-core-public.scopedhistory.replace.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Replaces the current location in the history stack. Does not remove forward or backward entries. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md deleted file mode 100644 index 226203502c5e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [push](./kibana-plugin-core-public.scopedhistory.push.md) - -## ScopedHistory.push property - -Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. - -Signature: - -```typescript -push: (pathOrLocation: Path | LocationDescriptorObject, state?: HistoryLocationState | undefined) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md deleted file mode 100644 index 545c81ead0984..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [replace](./kibana-plugin-core-public.scopedhistory.replace.md) - -## ScopedHistory.replace property - -Replaces the current location in the history stack. Does not remove forward or backward entries. - -Signature: - -```typescript -replace: (pathOrLocation: Path | LocationDescriptorObject, state?: HistoryLocationState | undefined) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md deleted file mode 100644 index 412154f7ac2e3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [(constructor)](./kibana-plugin-core-public.simplesavedobject._constructor_.md) - -## SimpleSavedObject.(constructor) - -Constructs a new instance of the `SimpleSavedObject` class - -Signature: - -```typescript -constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated_at: updatedAt, }: SavedObjectType); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| client | SavedObjectsClientContract | | -| { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated\_at: updatedAt, } | SavedObjectType<T> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md deleted file mode 100644 index 2e5d708143c5e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [\_version](./kibana-plugin-core-public.simplesavedobject._version.md) - -## SimpleSavedObject.\_version property - -Signature: - -```typescript -_version?: SavedObjectType['version']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md deleted file mode 100644 index cdca741c10adc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [attributes](./kibana-plugin-core-public.simplesavedobject.attributes.md) - -## SimpleSavedObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md deleted file mode 100644 index 8e2217fab6eee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) - -## SimpleSavedObject.coreMigrationVersion property - -Signature: - -```typescript -coreMigrationVersion: SavedObjectType['coreMigrationVersion']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md deleted file mode 100644 index cb848bff56430..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [delete](./kibana-plugin-core-public.simplesavedobject.delete.md) - -## SimpleSavedObject.delete() method - -Signature: - -```typescript -delete(): Promise<{}>; -``` -Returns: - -Promise<{}> - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md deleted file mode 100644 index 326b255272582..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [error](./kibana-plugin-core-public.simplesavedobject.error.md) - -## SimpleSavedObject.error property - -Signature: - -```typescript -error: SavedObjectType['error']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md deleted file mode 100644 index 9a9c27d78c06c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [get](./kibana-plugin-core-public.simplesavedobject.get.md) - -## SimpleSavedObject.get() method - -Signature: - -```typescript -get(key: string): any; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | - -Returns: - -any - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md deleted file mode 100644 index acd0ff02c7d23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [has](./kibana-plugin-core-public.simplesavedobject.has.md) - -## SimpleSavedObject.has() method - -Signature: - -```typescript -has(key: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md deleted file mode 100644 index 92c560f661e96..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [id](./kibana-plugin-core-public.simplesavedobject.id.md) - -## SimpleSavedObject.id property - -Signature: - -```typescript -id: SavedObjectType['id']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md deleted file mode 100644 index f151dc8bb5e09..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md +++ /dev/null @@ -1,47 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) - -## SimpleSavedObject class - -This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). - -It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. - -Signature: - -```typescript -export declare class SimpleSavedObject -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated\_at: updatedAt, })](./kibana-plugin-core-public.simplesavedobject._constructor_.md) | | Constructs a new instance of the SimpleSavedObject class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_version?](./kibana-plugin-core-public.simplesavedobject._version.md) | | SavedObjectType<T>\['version'\] | (Optional) | -| [attributes](./kibana-plugin-core-public.simplesavedobject.attributes.md) | | T | | -| [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) | | SavedObjectType<T>\['coreMigrationVersion'\] | | -| [error](./kibana-plugin-core-public.simplesavedobject.error.md) | | SavedObjectType<T>\['error'\] | | -| [id](./kibana-plugin-core-public.simplesavedobject.id.md) | | SavedObjectType<T>\['id'\] | | -| [migrationVersion](./kibana-plugin-core-public.simplesavedobject.migrationversion.md) | | SavedObjectType<T>\['migrationVersion'\] | | -| [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md) | | SavedObjectType<T>\['namespaces'\] | Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [references](./kibana-plugin-core-public.simplesavedobject.references.md) | | SavedObjectType<T>\['references'\] | | -| [type](./kibana-plugin-core-public.simplesavedobject.type.md) | | SavedObjectType<T>\['type'\] | | -| [updatedAt](./kibana-plugin-core-public.simplesavedobject.updatedat.md) | | SavedObjectType<T>\['updated\_at'\] | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [delete()](./kibana-plugin-core-public.simplesavedobject.delete.md) | | | -| [get(key)](./kibana-plugin-core-public.simplesavedobject.get.md) | | | -| [has(key)](./kibana-plugin-core-public.simplesavedobject.has.md) | | | -| [save()](./kibana-plugin-core-public.simplesavedobject.save.md) | | | -| [set(key, value)](./kibana-plugin-core-public.simplesavedobject.set.md) | | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md deleted file mode 100644 index a5d17f72513a2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [migrationVersion](./kibana-plugin-core-public.simplesavedobject.migrationversion.md) - -## SimpleSavedObject.migrationVersion property - -Signature: - -```typescript -migrationVersion: SavedObjectType['migrationVersion']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md deleted file mode 100644 index 7fb0a4e3a717a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md) - -## SimpleSavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces: SavedObjectType['namespaces']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md deleted file mode 100644 index 805309a151105..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [references](./kibana-plugin-core-public.simplesavedobject.references.md) - -## SimpleSavedObject.references property - -Signature: - -```typescript -references: SavedObjectType['references']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md deleted file mode 100644 index fdd262c70d4e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [save](./kibana-plugin-core-public.simplesavedobject.save.md) - -## SimpleSavedObject.save() method - -Signature: - -```typescript -save(): Promise>; -``` -Returns: - -Promise<SimpleSavedObject<T>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md deleted file mode 100644 index e3a6621f520bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [set](./kibana-plugin-core-public.simplesavedobject.set.md) - -## SimpleSavedObject.set() method - -Signature: - -```typescript -set(key: string, value: any): T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | -| value | any | | - -Returns: - -T - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md deleted file mode 100644 index ce5874bc3e0cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [type](./kibana-plugin-core-public.simplesavedobject.type.md) - -## SimpleSavedObject.type property - -Signature: - -```typescript -type: SavedObjectType['type']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md deleted file mode 100644 index 80b1f95969934..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [updatedAt](./kibana-plugin-core-public.simplesavedobject.updatedat.md) - -## SimpleSavedObject.updatedAt property - -Signature: - -```typescript -updatedAt: SavedObjectType['updated_at']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md b/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md deleted file mode 100644 index ad53307d53d69..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) - -## StartServicesAccessor type - -Allows plugins to get access to APIs available in start inside async handlers, such as [App.mount](./kibana-plugin-core-public.app.mount.md). Promise will not resolve until Core and plugin dependencies have completed `start`. - -Signature: - -```typescript -export declare type StartServicesAccessor = () => Promise<[CoreStart, TPluginsStart, TStart]>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toast.md b/docs/development/core/public/kibana-plugin-core-public.toast.md deleted file mode 100644 index 4acdfa4763d9c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toast.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Toast](./kibana-plugin-core-public.toast.md) - -## Toast type - -Signature: - -```typescript -export declare type Toast = ToastInputFields & { - id: string; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastinput.md b/docs/development/core/public/kibana-plugin-core-public.toastinput.md deleted file mode 100644 index c6e58227293b6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastinput.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastInput](./kibana-plugin-core-public.toastinput.md) - -## ToastInput type - -Inputs for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. - -Signature: - -```typescript -export declare type ToastInput = string | ToastInputFields; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md b/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md deleted file mode 100644 index 4eed737726835..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastInputFields](./kibana-plugin-core-public.toastinputfields.md) - -## ToastInputFields type - -Allowed fields for [ToastInput](./kibana-plugin-core-public.toastinput.md). - -Signature: - -```typescript -export declare type ToastInputFields = Pick> & { - title?: string | MountPoint; - text?: string | MountPoint; -}; -``` - -## Remarks - -`id` cannot be specified. - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastoptions.md b/docs/development/core/public/kibana-plugin-core-public.toastoptions.md deleted file mode 100644 index c140a2e52b036..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) - -## ToastOptions interface - -Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. - -Signature: - -```typescript -export interface ToastOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toastLifeTimeMs?](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) | number | (Optional) How long should the toast remain on screen. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md b/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md deleted file mode 100644 index bb0e2f9afc83b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) > [toastLifeTimeMs](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) - -## ToastOptions.toastLifeTimeMs property - -How long should the toast remain on screen. - -Signature: - -```typescript -toastLifeTimeMs?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md deleted file mode 100644 index c50cc4d6469ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [(constructor)](./kibana-plugin-core-public.toastsapi._constructor_.md) - -## ToastsApi.(constructor) - -Constructs a new instance of the `ToastsApi` class - -Signature: - -```typescript -constructor(deps: { - uiSettings: IUiSettingsClient; - }); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| deps | { uiSettings: IUiSettingsClient; } | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md deleted file mode 100644 index 7bee5af0c3be4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [add](./kibana-plugin-core-public.toastsapi.add.md) - -## ToastsApi.add() method - -Adds a new toast to current array of toast. - -Signature: - -```typescript -add(toastOrTitle: ToastInput): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md deleted file mode 100644 index f73a84996ff92..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addDanger](./kibana-plugin-core-public.toastsapi.adddanger.md) - -## ToastsApi.addDanger() method - -Adds a new toast pre-configured with the danger color and alert icon. - -Signature: - -```typescript -addDanger(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md deleted file mode 100644 index c1520ea392f70..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addError](./kibana-plugin-core-public.toastsapi.adderror.md) - -## ToastsApi.addError() method - -Adds a new toast that displays an exception message with a button to open the full stacktrace in a modal. - -Signature: - -```typescript -addError(error: Error, options: ErrorToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | an Error instance. | -| options | ErrorToastOptions | [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md deleted file mode 100644 index 7029482663155..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addInfo](./kibana-plugin-core-public.toastsapi.addinfo.md) - -## ToastsApi.addInfo() method - -Adds a new toast pre-configured with the info color and info icon. - -Signature: - -```typescript -addInfo(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md deleted file mode 100644 index b9cf4da3b43af..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addSuccess](./kibana-plugin-core-public.toastsapi.addsuccess.md) - -## ToastsApi.addSuccess() method - -Adds a new toast pre-configured with the success color and check icon. - -Signature: - -```typescript -addSuccess(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md deleted file mode 100644 index 790af0d26220a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addWarning](./kibana-plugin-core-public.toastsapi.addwarning.md) - -## ToastsApi.addWarning() method - -Adds a new toast pre-configured with the warning color and help icon. - -Signature: - -```typescript -addWarning(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md deleted file mode 100644 index 275d30fd54e0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [get$](./kibana-plugin-core-public.toastsapi.get_.md) - -## ToastsApi.get$() method - -Observable of the toast messages to show to the user. - -Signature: - -```typescript -get$(): Rx.Observable; -``` -Returns: - -Rx.Observable<Toast\[\]> - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.md deleted file mode 100644 index 4d7f9dcacfa6f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) - -## ToastsApi class - -Methods for adding and removing global toast messages. - -Signature: - -```typescript -export declare class ToastsApi implements IToasts -``` -Implements: IToasts - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(deps)](./kibana-plugin-core-public.toastsapi._constructor_.md) | | Constructs a new instance of the ToastsApi class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [add(toastOrTitle)](./kibana-plugin-core-public.toastsapi.add.md) | | Adds a new toast to current array of toast. | -| [addDanger(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.adddanger.md) | | Adds a new toast pre-configured with the danger color and alert icon. | -| [addError(error, options)](./kibana-plugin-core-public.toastsapi.adderror.md) | | Adds a new toast that displays an exception message with a button to open the full stacktrace in a modal. | -| [addInfo(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addinfo.md) | | Adds a new toast pre-configured with the info color and info icon. | -| [addSuccess(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addsuccess.md) | | Adds a new toast pre-configured with the success color and check icon. | -| [addWarning(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addwarning.md) | | Adds a new toast pre-configured with the warning color and help icon. | -| [get$()](./kibana-plugin-core-public.toastsapi.get_.md) | | Observable of the toast messages to show to the user. | -| [remove(toastOrId)](./kibana-plugin-core-public.toastsapi.remove.md) | | Removes a toast from the current array of toasts if present. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md deleted file mode 100644 index aeac9f46b7901..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [remove](./kibana-plugin-core-public.toastsapi.remove.md) - -## ToastsApi.remove() method - -Removes a toast from the current array of toasts if present. - -Signature: - -```typescript -remove(toastOrId: Toast | string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrId | Toast \| string | a [Toast](./kibana-plugin-core-public.toast.md) returned by [ToastsApi.add()](./kibana-plugin-core-public.toastsapi.add.md) or its id | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastssetup.md b/docs/development/core/public/kibana-plugin-core-public.toastssetup.md deleted file mode 100644 index c704a3ec1d80a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastssetup.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) - -## ToastsSetup type - -[IToasts](./kibana-plugin-core-public.itoasts.md) - -Signature: - -```typescript -export declare type ToastsSetup = IToasts; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsstart.md b/docs/development/core/public/kibana-plugin-core-public.toastsstart.md deleted file mode 100644 index 3b2cf97e4ddf0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsStart](./kibana-plugin-core-public.toastsstart.md) - -## ToastsStart type - -[IToasts](./kibana-plugin-core-public.itoasts.md) - -Signature: - -```typescript -export declare type ToastsStart = IToasts; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md deleted file mode 100644 index 4b67d32e6bc27..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [category](./kibana-plugin-core-public.uisettingsparams.category.md) - -## UiSettingsParams.category property - -used to group the configured setting in the UI - -Signature: - -```typescript -category?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md deleted file mode 100644 index a68cbed7662e3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) - -## UiSettingsParams.deprecation property - -optional deprecation information. Used to generate a deprecation warning. - -Signature: - -```typescript -deprecation?: DeprecationSettings; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md deleted file mode 100644 index 25e616dbaa90a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [description](./kibana-plugin-core-public.uisettingsparams.description.md) - -## UiSettingsParams.description property - -description provided to a user in UI - -Signature: - -```typescript -description?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md deleted file mode 100644 index 325ce96f36ca3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) - -## UiSettingsParams interface - -UiSettings parameters defined by the plugins. - -Signature: - -```typescript -export interface UiSettingsParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./kibana-plugin-core-public.uisettingsparams.category.md) | string\[\] | (Optional) used to group the configured setting in the UI | -| [deprecation?](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | DeprecationSettings | (Optional) optional deprecation information. Used to generate a deprecation warning. | -| [description?](./kibana-plugin-core-public.uisettingsparams.description.md) | string | (Optional) description provided to a user in UI | -| [metric?](./kibana-plugin-core-public.uisettingsparams.metric.md) | { type: UiCounterMetricType; name: string; } | (Optional) Metric to track once this property changes | -| [name?](./kibana-plugin-core-public.uisettingsparams.name.md) | string | (Optional) title in the UI | -| [optionLabels?](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | Record<string, string> | (Optional) text labels for 'select' type UI element | -| [options?](./kibana-plugin-core-public.uisettingsparams.options.md) | string\[\] | (Optional) array of permitted values for this setting | -| [order?](./kibana-plugin-core-public.uisettingsparams.order.md) | number | (Optional) index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. settings without order defined will be displayed last and ordered by name | -| [readonly?](./kibana-plugin-core-public.uisettingsparams.readonly.md) | boolean | (Optional) a flag indicating that value cannot be changed | -| [requiresPageReload?](./kibana-plugin-core-public.uisettingsparams.requirespagereload.md) | boolean | (Optional) a flag indicating whether new value applying requires page reloading | -| [schema](./kibana-plugin-core-public.uisettingsparams.schema.md) | Type<T> | | -| [sensitive?](./kibana-plugin-core-public.uisettingsparams.sensitive.md) | boolean | (Optional) a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. | -| [type?](./kibana-plugin-core-public.uisettingsparams.type.md) | UiSettingsType | (Optional) defines a type of UI element [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) | -| [value?](./kibana-plugin-core-public.uisettingsparams.value.md) | T | (Optional) default value to fall back to if a user doesn't provide any | - diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md deleted file mode 100644 index c6d288ec8f542..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) - -## UiSettingsParams.metric property - -> Warning: This API is now obsolete. -> -> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place -> - -Metric to track once this property changes - -Signature: - -```typescript -metric?: { - type: UiCounterMetricType; - name: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md deleted file mode 100644 index a86ba4d49725a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [name](./kibana-plugin-core-public.uisettingsparams.name.md) - -## UiSettingsParams.name property - -title in the UI - -Signature: - -```typescript -name?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md deleted file mode 100644 index 35e90878a0dab..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) - -## UiSettingsParams.optionLabels property - -text labels for 'select' type UI element - -Signature: - -```typescript -optionLabels?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md deleted file mode 100644 index 60060d7c3223d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [options](./kibana-plugin-core-public.uisettingsparams.options.md) - -## UiSettingsParams.options property - -array of permitted values for this setting - -Signature: - -```typescript -options?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md deleted file mode 100644 index d93aaeb904616..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [order](./kibana-plugin-core-public.uisettingsparams.order.md) - -## UiSettingsParams.order property - -index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. - - settings without order defined will be displayed last and ordered by name - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md deleted file mode 100644 index 03c5cd6201825..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [readonly](./kibana-plugin-core-public.uisettingsparams.readonly.md) - -## UiSettingsParams.readonly property - -a flag indicating that value cannot be changed - -Signature: - -```typescript -readonly?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md deleted file mode 100644 index 2ce396dbc6a81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [requiresPageReload](./kibana-plugin-core-public.uisettingsparams.requirespagereload.md) - -## UiSettingsParams.requiresPageReload property - -a flag indicating whether new value applying requires page reloading - -Signature: - -```typescript -requiresPageReload?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md deleted file mode 100644 index f90d5161f96a9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [schema](./kibana-plugin-core-public.uisettingsparams.schema.md) - -## UiSettingsParams.schema property - -Signature: - -```typescript -schema: Type; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md deleted file mode 100644 index e12f3c5649f17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [sensitive](./kibana-plugin-core-public.uisettingsparams.sensitive.md) - -## UiSettingsParams.sensitive property - -a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. - -Signature: - -```typescript -sensitive?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md deleted file mode 100644 index 128e8f3ce7761..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [type](./kibana-plugin-core-public.uisettingsparams.type.md) - -## UiSettingsParams.type property - -defines a type of UI element [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) - -Signature: - -```typescript -type?: UiSettingsType; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md deleted file mode 100644 index 2740f169eeecb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [value](./kibana-plugin-core-public.uisettingsparams.value.md) - -## UiSettingsParams.value property - -default value to fall back to if a user doesn't provide any - -Signature: - -```typescript -value?: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md deleted file mode 100644 index 8aae7904276e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsState](./kibana-plugin-core-public.uisettingsstate.md) - -## UiSettingsState interface - - -Signature: - -```typescript -export interface UiSettingsState -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md b/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md deleted file mode 100644 index 65e6264ea1e08..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) - -## UiSettingsType type - -UI element type to represent the settings. - -Signature: - -```typescript -export declare type UiSettingsType = 'undefined' | 'json' | 'markdown' | 'number' | 'select' | 'boolean' | 'string' | 'array' | 'image' | 'color'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md b/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md deleted file mode 100644 index e4570de5a0f31..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UnmountCallback](./kibana-plugin-core-public.unmountcallback.md) - -## UnmountCallback type - -A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-core-public.mountpoint.md) - -Signature: - -```typescript -export declare type UnmountCallback = () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.url_max_length.md b/docs/development/core/public/kibana-plugin-core-public.url_max_length.md deleted file mode 100644 index 993320d51909a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.url_max_length.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md) - -## URL\_MAX\_LENGTH variable - -The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit. - -Signature: - -```typescript -URL_MAX_LENGTH: number -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md deleted file mode 100644 index 2d9994e442f00..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) > [isOverridden](./kibana-plugin-core-public.userprovidedvalues.isoverridden.md) - -## UserProvidedValues.isOverridden property - -Signature: - -```typescript -isOverridden?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md deleted file mode 100644 index eb8f0124c3341..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) - -## UserProvidedValues interface - -Describes the values explicitly set by user. - -Signature: - -```typescript -export interface UserProvidedValues -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isOverridden?](./kibana-plugin-core-public.userprovidedvalues.isoverridden.md) | boolean | (Optional) | -| [userValue?](./kibana-plugin-core-public.userprovidedvalues.uservalue.md) | T | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md deleted file mode 100644 index 8925852f6e80d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) > [userValue](./kibana-plugin-core-public.userprovidedvalues.uservalue.md) - -## UserProvidedValues.userValue property - -Signature: - -```typescript -userValue?: T; -``` diff --git a/docs/development/core/server/index.md b/docs/development/core/server/index.md deleted file mode 100644 index 2f215c322cdc8..0000000000000 --- a/docs/development/core/server/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [kibana-plugin-core-server](./kibana-plugin-core-server.md) | The Kibana Core APIs for server-side plugins.A plugin requires a kibana.json file at it's root directory that follows to define static plugin information required to load the plugin.A plugin's server/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md deleted file mode 100644 index e1129181dbb49..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) - -## AnalyticsServicePreboot type - -Exposes the public APIs of the AnalyticsClient during the preboot phase - -Signature: - -```typescript -export declare type AnalyticsServicePreboot = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md deleted file mode 100644 index 5dc90eb0c1f03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) - -## AnalyticsServiceSetup type - -Exposes the public APIs of the AnalyticsClient during the setup phase. - -Signature: - -```typescript -export declare type AnalyticsServiceSetup = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md deleted file mode 100644 index 828577889da61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) - -## AnalyticsServiceStart type - -Exposes the public APIs of the AnalyticsClient during the start phase - -Signature: - -```typescript -export declare type AnalyticsServiceStart = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md b/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md deleted file mode 100644 index cdb0b909bf79d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [APP\_WRAPPER\_CLASS](./kibana-plugin-core-server.app_wrapper_class.md) - -## APP\_WRAPPER\_CLASS variable - -The class name for top level \*and\* nested application wrappers to ensure proper layout - -Signature: - -```typescript -APP_WRAPPER_CLASS = "kbnAppWrapper" -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md deleted file mode 100644 index fe81f7cffaa41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [ariaLabel](./kibana-plugin-core-server.appcategory.arialabel.md) - -## AppCategory.ariaLabel property - -If the visual label isn't appropriate for screen readers, can override it here - -Signature: - -```typescript -ariaLabel?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md deleted file mode 100644 index 79de37ea619f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [euiIconType](./kibana-plugin-core-server.appcategory.euiicontype.md) - -## AppCategory.euiIconType property - -Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md deleted file mode 100644 index f0889d200725a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [id](./kibana-plugin-core-server.appcategory.id.md) - -## AppCategory.id property - -Unique identifier for the categories - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md deleted file mode 100644 index 9405118ed7a11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [label](./kibana-plugin-core-server.appcategory.label.md) - -## AppCategory.label property - -Label used for category name. Also used as aria-label if one isn't set. - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.md deleted file mode 100644 index ca5e8b354d451..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) - -## AppCategory interface - -A category definition for nav links to know where to sort them in the left hand nav - -Signature: - -```typescript -export interface AppCategory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ariaLabel?](./kibana-plugin-core-server.appcategory.arialabel.md) | string | (Optional) If the visual label isn't appropriate for screen readers, can override it here | -| [euiIconType?](./kibana-plugin-core-server.appcategory.euiicontype.md) | string | (Optional) Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined | -| [id](./kibana-plugin-core-server.appcategory.id.md) | string | Unique identifier for the categories | -| [label](./kibana-plugin-core-server.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. | -| [order?](./kibana-plugin-core-server.appcategory.order.md) | number | (Optional) The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md deleted file mode 100644 index aba1b886076ad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [order](./kibana-plugin-core-server.appcategory.order.md) - -## AppCategory.order property - -The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md deleted file mode 100644 index bd528e59878ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) - -## AsyncPlugin interface - -> Warning: This API is now obsolete. -> -> Asynchronous lifecycles are deprecated, and should be migrated to sync 8.8.0 -> - -A plugin with asynchronous lifecycle methods. - -Signature: - -```typescript -export interface AsyncPlugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.asyncplugin.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-server.asyncplugin.start.md) | | -| [stop()?](./kibana-plugin-core-server.asyncplugin.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md deleted file mode 100644 index 73752d6c9bd20..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [setup](./kibana-plugin-core-server.asyncplugin.setup.md) - -## AsyncPlugin.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup \| Promise<TSetup> - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md deleted file mode 100644 index 98cf74341062a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [start](./kibana-plugin-core-server.asyncplugin.start.md) - -## AsyncPlugin.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart | Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart \| Promise<TStart> - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md deleted file mode 100644 index 80c554f343346..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [stop](./kibana-plugin-core-server.asyncplugin.stop.md) - -## AsyncPlugin.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticated.md b/docs/development/core/server/kibana-plugin-core-server.authenticated.md deleted file mode 100644 index 90b480d4a026c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticated.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Authenticated](./kibana-plugin-core-server.authenticated.md) - -## Authenticated interface - - -Signature: - -```typescript -export interface Authenticated extends AuthResultParams -``` -Extends: AuthResultParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authenticated.type.md) | AuthResultType.authenticated | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md b/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md deleted file mode 100644 index f655ecac12606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Authenticated](./kibana-plugin-core-server.authenticated.md) > [type](./kibana-plugin-core-server.authenticated.type.md) - -## Authenticated.type property - -Signature: - -```typescript -type: AuthResultType.authenticated; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md b/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md deleted file mode 100644 index d7a456dc127af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md) - -## AuthenticationHandler type - -See [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md). - -Signature: - -```typescript -export declare type AuthenticationHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: AuthToolkit) => AuthResult | IKibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authheaders.md b/docs/development/core/server/kibana-plugin-core-server.authheaders.md deleted file mode 100644 index 60c3c0be7e552..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthHeaders](./kibana-plugin-core-server.authheaders.md) - -## AuthHeaders type - -Auth Headers map - -Signature: - -```typescript -export declare type AuthHeaders = Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authnothandled.md b/docs/development/core/server/kibana-plugin-core-server.authnothandled.md deleted file mode 100644 index 297f60e4bd8ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authnothandled.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) - -## AuthNotHandled interface - - -Signature: - -```typescript -export interface AuthNotHandled -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authnothandled.type.md) | AuthResultType.notHandled | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md b/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md deleted file mode 100644 index 0e328b704153d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) > [type](./kibana-plugin-core-server.authnothandled.type.md) - -## AuthNotHandled.type property - -Signature: - -```typescript -type: AuthResultType.notHandled; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirected.md b/docs/development/core/server/kibana-plugin-core-server.authredirected.md deleted file mode 100644 index 4da08e49056f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirected.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirected](./kibana-plugin-core-server.authredirected.md) - -## AuthRedirected interface - - -Signature: - -```typescript -export interface AuthRedirected extends AuthRedirectedParams -``` -Extends: AuthRedirectedParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authredirected.type.md) | AuthResultType.redirected | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md b/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md deleted file mode 100644 index b906656818b85..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirected](./kibana-plugin-core-server.authredirected.md) > [type](./kibana-plugin-core-server.authredirected.type.md) - -## AuthRedirected.type property - -Signature: - -```typescript -type: AuthResultType.redirected; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md b/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md deleted file mode 100644 index b500e0c494f61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) > [headers](./kibana-plugin-core-server.authredirectedparams.headers.md) - -## AuthRedirectedParams.headers property - -Headers to attach for auth redirect. Must include "location" header - -Signature: - -```typescript -headers: { - location: string; - } & ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md b/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md deleted file mode 100644 index 2f6ef7c6f6ba4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) - -## AuthRedirectedParams interface - -Result of auth redirection. - -Signature: - -```typescript -export interface AuthRedirectedParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers](./kibana-plugin-core-server.authredirectedparams.headers.md) | { location: string; } & ResponseHeaders | Headers to attach for auth redirect. Must include "location" header | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authresult.md b/docs/development/core/server/kibana-plugin-core-server.authresult.md deleted file mode 100644 index e523353d83f4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresult.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResult](./kibana-plugin-core-server.authresult.md) - -## AuthResult type - - -Signature: - -```typescript -export declare type AuthResult = Authenticated | AuthNotHandled | AuthRedirected; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.md deleted file mode 100644 index 7e907a9bf7a77..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) - -## AuthResultParams interface - -Result of successful authentication. - -Signature: - -```typescript -export interface AuthResultParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [requestHeaders?](./kibana-plugin-core-server.authresultparams.requestheaders.md) | AuthHeaders | (Optional) Auth specific headers to attach to a request object. Used to perform a request to Elasticsearch on behalf of an authenticated user. | -| [responseHeaders?](./kibana-plugin-core-server.authresultparams.responseheaders.md) | AuthHeaders | (Optional) Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. | -| [state?](./kibana-plugin-core-server.authresultparams.state.md) | Record<string, any> | (Optional) Data to associate with an incoming request. Any downstream plugin may get access to the data. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md deleted file mode 100644 index aa5b054a93e56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [requestHeaders](./kibana-plugin-core-server.authresultparams.requestheaders.md) - -## AuthResultParams.requestHeaders property - -Auth specific headers to attach to a request object. Used to perform a request to Elasticsearch on behalf of an authenticated user. - -Signature: - -```typescript -requestHeaders?: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md deleted file mode 100644 index 5a203c83f6394..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [responseHeaders](./kibana-plugin-core-server.authresultparams.responseheaders.md) - -## AuthResultParams.responseHeaders property - -Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. - -Signature: - -```typescript -responseHeaders?: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md deleted file mode 100644 index 8d35f1676b318..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [state](./kibana-plugin-core-server.authresultparams.state.md) - -## AuthResultParams.state property - -Data to associate with an incoming request. Any downstream plugin may get access to the data. - -Signature: - -```typescript -state?: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresulttype.md b/docs/development/core/server/kibana-plugin-core-server.authresulttype.md deleted file mode 100644 index 5e68edd9aa66b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresulttype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultType](./kibana-plugin-core-server.authresulttype.md) - -## AuthResultType enum - - -Signature: - -```typescript -export declare enum AuthResultType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| authenticated | "authenticated" | | -| notHandled | "notHandled" | | -| redirected | "redirected" | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authstatus.md b/docs/development/core/server/kibana-plugin-core-server.authstatus.md deleted file mode 100644 index d022392c6f188..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authstatus.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthStatus](./kibana-plugin-core-server.authstatus.md) - -## AuthStatus enum - -Status indicating an outcome of the authentication. - -Signature: - -```typescript -export declare enum AuthStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| authenticated | "authenticated" | auth interceptor successfully authenticated a user | -| unauthenticated | "unauthenticated" | auth interceptor failed user authentication | -| unknown | "unknown" | auth interceptor has not been registered | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md deleted file mode 100644 index 7cfb4efd29662..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [authenticated](./kibana-plugin-core-server.authtoolkit.authenticated.md) - -## AuthToolkit.authenticated property - -Authentication is successful with given credentials, allow request to pass through - -Signature: - -```typescript -authenticated: (data?: AuthResultParams) => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md deleted file mode 100644 index 24b561d04bbb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) - -## AuthToolkit interface - -A tool set defining an outcome of Auth interceptor for incoming request. - -Signature: - -```typescript -export interface AuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authenticated](./kibana-plugin-core-server.authtoolkit.authenticated.md) | (data?: AuthResultParams) => AuthResult | Authentication is successful with given credentials, allow request to pass through | -| [notHandled](./kibana-plugin-core-server.authtoolkit.nothandled.md) | () => AuthResult | User has no credentials. Allows user to access a resource when authRequired is 'optional' Rejects a request when authRequired: true | -| [redirected](./kibana-plugin-core-server.authtoolkit.redirected.md) | (headers: { location: string; } & ResponseHeaders) => AuthResult | Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md deleted file mode 100644 index 577faa6562558..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [notHandled](./kibana-plugin-core-server.authtoolkit.nothandled.md) - -## AuthToolkit.notHandled property - -User has no credentials. Allows user to access a resource when authRequired is 'optional' Rejects a request when authRequired: true - -Signature: - -```typescript -notHandled: () => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md deleted file mode 100644 index 92d2181f24765..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [redirected](./kibana-plugin-core-server.authtoolkit.redirected.md) - -## AuthToolkit.redirected property - -Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' - -Signature: - -```typescript -redirected: (headers: { - location: string; - } & ResponseHeaders) => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md deleted file mode 100644 index 273945166735b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [correctiveActions](./kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md) - -## BaseDeprecationDetails.correctiveActions property - -corrective action needed to fix this deprecation. - -Signature: - -```typescript -correctiveActions: { - api?: { - path: string; - method: 'POST' | 'PUT'; - body?: { - [key: string]: any; - }; - omitContextFromBody?: boolean; - }; - manualSteps: string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md deleted file mode 100644 index 072dfd17418f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md) - -## BaseDeprecationDetails.deprecationType property - -(optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab. - -Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations. - -Signature: - -```typescript -deprecationType?: 'config' | 'feature'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md deleted file mode 100644 index c8f0762acdce6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [documentationUrl](./kibana-plugin-core-server.basedeprecationdetails.documentationurl.md) - -## BaseDeprecationDetails.documentationUrl property - -(optional) link to the documentation for more details on the deprecation. - -Signature: - -```typescript -documentationUrl?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md deleted file mode 100644 index ad755805d00b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [level](./kibana-plugin-core-server.basedeprecationdetails.level.md) - -## BaseDeprecationDetails.level property - -levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. - -Signature: - -```typescript -level: 'warning' | 'critical' | 'fetch_error'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md deleted file mode 100644 index bcd96e35295ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) - -## BaseDeprecationDetails interface - -Base properties shared by all types of deprecations - -Signature: - -```typescript -export interface BaseDeprecationDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [correctiveActions](./kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md) | { api?: { path: string; method: 'POST' \| 'PUT'; body?: { \[key: string\]: any; }; omitContextFromBody?: boolean; }; manualSteps: string\[\]; } | corrective action needed to fix this deprecation. | -| [deprecationType?](./kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md) | 'config' \| 'feature' | (Optional) (optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab.Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations. | -| [documentationUrl?](./kibana-plugin-core-server.basedeprecationdetails.documentationurl.md) | string | (Optional) (optional) link to the documentation for more details on the deprecation. | -| [level](./kibana-plugin-core-server.basedeprecationdetails.level.md) | 'warning' \| 'critical' \| 'fetch\_error' | levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. | -| [message](./kibana-plugin-core-server.basedeprecationdetails.message.md) | string | The description message to be displayed for the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx | -| [requireRestart?](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) | boolean | (Optional) (optional) specify the fix for this deprecation requires a full kibana restart. | -| [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) | string | The title of the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx | - diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md deleted file mode 100644 index 5802bc316cc08..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [message](./kibana-plugin-core-server.basedeprecationdetails.message.md) - -## BaseDeprecationDetails.message property - -The description message to be displayed for the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx` - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md deleted file mode 100644 index 3f589600d0458..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [requireRestart](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) - -## BaseDeprecationDetails.requireRestart property - -(optional) specify the fix for this deprecation requires a full kibana restart. - -Signature: - -```typescript -requireRestart?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md deleted file mode 100644 index b6788a4faa7c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) - -## BaseDeprecationDetails.title property - -The title of the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx` - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md b/docs/development/core/server/kibana-plugin-core-server.basepath.get.md deleted file mode 100644 index b35c6e657b01f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [get](./kibana-plugin-core-server.basepath.get.md) - -## BasePath.get property - -returns `basePath` value, specific for an incoming request. - -Signature: - -```typescript -get: (request: KibanaRequest) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.md deleted file mode 100644 index 4fae861cf1659..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) - -## BasePath class - -Access or manipulate the Kibana base path - -Signature: - -```typescript -export declare class BasePath -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [get](./kibana-plugin-core-server.basepath.get.md) | | (request: KibanaRequest) => string | returns basePath value, specific for an incoming request. | -| [prepend](./kibana-plugin-core-server.basepath.prepend.md) | | (path: string) => string | Prepends path with the basePath. | -| [publicBaseUrl?](./kibana-plugin-core-server.basepath.publicbaseurl.md) | | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). | -| [remove](./kibana-plugin-core-server.basepath.remove.md) | | (path: string) => string | Removes the prepended basePath from the path. | -| [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) | | string | returns the server's basePathSee [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request | -| [set](./kibana-plugin-core-server.basepath.set.md) | | (request: KibanaRequest, requestSpecificBasePath: string) => void | sets basePath value, specific for an incoming request. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md b/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md deleted file mode 100644 index 94ddf74372cc4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [prepend](./kibana-plugin-core-server.basepath.prepend.md) - -## BasePath.prepend property - -Prepends `path` with the basePath. - -Signature: - -```typescript -prepend: (path: string) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md b/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md deleted file mode 100644 index 65842333ac246..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md) - -## BasePath.publicBaseUrl property - -The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). - -Signature: - -```typescript -readonly publicBaseUrl?: string; -``` - -## Remarks - -Should be used for generating external URL links back to this Kibana instance. - diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md b/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md deleted file mode 100644 index 13ccd9db6ab86..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [remove](./kibana-plugin-core-server.basepath.remove.md) - -## BasePath.remove property - -Removes the prepended basePath from the `path`. - -Signature: - -```typescript -remove: (path: string) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md deleted file mode 100644 index 01fc9b69055f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) - -## BasePath.serverBasePath property - -returns the server's basePath - -See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request - -Signature: - -```typescript -readonly serverBasePath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md b/docs/development/core/server/kibana-plugin-core-server.basepath.set.md deleted file mode 100644 index b90767022d594..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [set](./kibana-plugin-core-server.basepath.set.md) - -## BasePath.set property - -sets `basePath` value, specific for an incoming request. - -Signature: - -```typescript -set: (request: KibanaRequest, requestSpecificBasePath: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md deleted file mode 100644 index 7b93d3b885d23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [catalogue](./kibana-plugin-core-server.capabilities.catalogue.md) - -## Capabilities.catalogue property - -Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. - -Signature: - -```typescript -catalogue: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md deleted file mode 100644 index 968faadf43774..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [management](./kibana-plugin-core-server.capabilities.management.md) - -## Capabilities.management property - -Management section capabilities. - -Signature: - -```typescript -management: { - [sectionId: string]: Record; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.md deleted file mode 100644 index a5900e96a86b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) - -## Capabilities interface - -The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. - -Signature: - -```typescript -export interface Capabilities -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [catalogue](./kibana-plugin-core-server.capabilities.catalogue.md) | Record<string, boolean> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. | -| [management](./kibana-plugin-core-server.capabilities.management.md) | { \[sectionId: string\]: Record<string, boolean>; } | Management section capabilities. | -| [navLinks](./kibana-plugin-core-server.capabilities.navlinks.md) | Record<string, boolean> | Navigation link capabilities. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md deleted file mode 100644 index 0e68239ff4eee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [navLinks](./kibana-plugin-core-server.capabilities.navlinks.md) - -## Capabilities.navLinks property - -Navigation link capabilities. - -Signature: - -```typescript -navLinks: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md deleted file mode 100644 index 2f71e4b9bb18a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) - -## CapabilitiesProvider type - -See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -export declare type CapabilitiesProvider = () => Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md deleted file mode 100644 index 19e7f05b20415..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -## CapabilitiesSetup interface - -APIs to manage the [Capabilities](./kibana-plugin-core-server.capabilities.md) that will be used by the application. - -Plugins relying on capabilities to toggle some of their features should register them during the setup phase using the `registerProvider` method. - -Plugins having the responsibility to restrict capabilities depending on a given context should register their capabilities switcher using the `registerSwitcher` method. - -Refers to the methods documentation for complete description and examples. - -Signature: - -```typescript -export interface CapabilitiesSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [registerProvider(provider)](./kibana-plugin-core-server.capabilitiessetup.registerprovider.md) | Register a [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) to be used to provide [Capabilities](./kibana-plugin-core-server.capabilities.md) when resolving them. | -| [registerSwitcher(switcher)](./kibana-plugin-core-server.capabilitiessetup.registerswitcher.md) | Register a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) to be used to change the default state of the [Capabilities](./kibana-plugin-core-server.capabilities.md) entries when resolving them.A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md deleted file mode 100644 index 9122f7e0f11ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) > [registerProvider](./kibana-plugin-core-server.capabilitiessetup.registerprovider.md) - -## CapabilitiesSetup.registerProvider() method - -Register a [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) to be used to provide [Capabilities](./kibana-plugin-core-server.capabilities.md) when resolving them. - -Signature: - -```typescript -registerProvider(provider: CapabilitiesProvider): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| provider | CapabilitiesProvider | | - -Returns: - -void - -## Example - -How to register a plugin's capabilities during setup - -```ts -// my-plugin/server/plugin.ts -public setup(core: CoreSetup, deps: {}) { - core.capabilities.registerProvider(() => { - return { - catalogue: { - myPlugin: true, - }, - myPlugin: { - someFeature: true, - featureDisabledByDefault: false, - }, - } - }); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md deleted file mode 100644 index c07703c1f365f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) > [registerSwitcher](./kibana-plugin-core-server.capabilitiessetup.registerswitcher.md) - -## CapabilitiesSetup.registerSwitcher() method - -Register a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) to be used to change the default state of the [Capabilities](./kibana-plugin-core-server.capabilities.md) entries when resolving them. - -A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored. - -Signature: - -```typescript -registerSwitcher(switcher: CapabilitiesSwitcher): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| switcher | CapabilitiesSwitcher | | - -Returns: - -void - -## Example - -How to restrict some capabilities - -```ts -// my-plugin/server/plugin.ts -public setup(core: CoreSetup, deps: {}) { - core.capabilities.registerSwitcher((request, capabilities, useDefaultCapabilities) => { - // useDefaultCapabilities is a special case that switchers typically don't have to concern themselves with. - // The default capabilities are typically the ones you provide in your CapabilitiesProvider, but this flag - // gives each switcher an opportunity to change the default capabilities of other plugins' capabilities. - // For example, you may decide to flip another plugin's capability to false if today is Tuesday, - // but you wouldn't want to do this when we are requesting the default set of capabilities. - if (useDefaultCapabilities) { - return { - somePlugin: { - featureEnabledByDefault: true - } - } - } - if(myPluginApi.shouldRestrictSomePluginBecauseOf(request)) { - return { - somePlugin: { - featureEnabledByDefault: false // `featureEnabledByDefault` will be disabled. All other capabilities will remain unchanged. - } - } - } - return {}; // All capabilities will remain unchanged. - }); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md deleted file mode 100644 index 217a782be9d8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) - -## CapabilitiesStart interface - -APIs to access the application [Capabilities](./kibana-plugin-core-server.capabilities.md). - -Signature: - -```typescript -export interface CapabilitiesStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [resolveCapabilities(request, options)](./kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md) | Resolve the [Capabilities](./kibana-plugin-core-server.capabilities.md) to be used for given request | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md deleted file mode 100644 index a9dc279526065..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) > [resolveCapabilities](./kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md) - -## CapabilitiesStart.resolveCapabilities() method - -Resolve the [Capabilities](./kibana-plugin-core-server.capabilities.md) to be used for given request - -Signature: - -```typescript -resolveCapabilities(request: KibanaRequest, options?: ResolveCapabilitiesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | KibanaRequest | | -| options | ResolveCapabilitiesOptions | | - -Returns: - -Promise<Capabilities> - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md deleted file mode 100644 index e6a0a9a096671..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) - -## CapabilitiesSwitcher type - -See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -export declare type CapabilitiesSwitcher = (request: KibanaRequest, uiCapabilities: Capabilities, useDefaultCapabilities: boolean) => Partial | Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md deleted file mode 100644 index 7af6c16d86e4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) > [configPath](./kibana-plugin-core-server.configdeprecationdetails.configpath.md) - -## ConfigDeprecationDetails.configPath property - -Signature: - -```typescript -configPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md deleted file mode 100644 index fb3737062f986..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md) - -## ConfigDeprecationDetails.deprecationType property - -Signature: - -```typescript -deprecationType: 'config'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md deleted file mode 100644 index 6065d1fc1889f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) - -## ConfigDeprecationDetails interface - - -Signature: - -```typescript -export interface ConfigDeprecationDetails extends BaseDeprecationDetails -``` -Extends: BaseDeprecationDetails - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [configPath](./kibana-plugin-core-server.configdeprecationdetails.configpath.md) | string | | -| [deprecationType](./kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md) | 'config' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md deleted file mode 100644 index 5e60dd7e2ffd7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ContextSetup](./kibana-plugin-core-server.contextsetup.md) > [createContextContainer](./kibana-plugin-core-server.contextsetup.createcontextcontainer.md) - -## ContextSetup.createContextContainer() method - -Creates a new [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for a service owner. - -Signature: - -```typescript -createContextContainer(): IContextContainer; -``` -Returns: - -IContextContainer - diff --git a/docs/development/core/server/kibana-plugin-core-server.contextsetup.md b/docs/development/core/server/kibana-plugin-core-server.contextsetup.md deleted file mode 100644 index a15adccc97714..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.contextsetup.md +++ /dev/null @@ -1,136 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ContextSetup](./kibana-plugin-core-server.contextsetup.md) - -## ContextSetup interface - -An object that handles registration of context providers and configuring handlers with context. - -Signature: - -```typescript -export interface ContextSetup -``` - -## Remarks - -A [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares. - -Contexts providers are executed in the order they were registered. Each provider gets access to context values provided by any plugins that it depends on. - -In order to configure a handler with context, you must call the [IContextContainer.createHandler()](./kibana-plugin-core-server.icontextcontainer.createhandler.md) function and use the returned handler which will automatically build a context object when called. - -When registering context or creating handlers, the \_calling plugin's opaque id\_ must be provided. This id is passed in via the plugin's initializer and can be accessed from the [PluginInitializerContext.opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) Note this should NOT be the context service owner's id, but the plugin that is actually registering the context or handler. - -```ts -// Correct -class MyPlugin { - private readonly handlers = new Map(); - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(pluginOpaqueId, contextName, provider) { - this.contextContainer.registerContext(pluginOpaqueId, contextName, provider); - }, - registerRoute(pluginOpaqueId, path, handler) { - this.handlers.set( - path, - this.contextContainer.createHandler(pluginOpaqueId, handler) - ); - } - } - } -} - -// Incorrect -class MyPlugin { - private readonly handlers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(contextName, provider) { - // BUG! - // This would leak this context to all handlers rather that only plugins that depend on the calling plugin. - this.contextContainer.registerContext(this.initContext.opaqueId, contextName, provider); - }, - registerRoute(path, handler) { - this.handlers.set( - path, - // BUG! - // This handler will not receive any contexts provided by other dependencies of the calling plugin. - this.contextContainer.createHandler(this.initContext.opaqueId, handler) - ); - } - } - } -} -``` - -## Example - -Say we're creating a plugin for rendering visualizations that allows new rendering methods to be registered. If we want to offer context to these rendering methods, we can leverage the ContextService to manage these contexts. - -```ts -export interface VizRenderContext { - core: { - i18n: I18nStart; - uiSettings: IUiSettingsClient; - } - [contextName: string]: unknown; -} - -export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void; -// When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned. -type BoundVizRenderer = (domElement: HTMLElement) => () => void; - -class VizRenderingPlugin { - private readonly contextContainer?: IContextContainer; - private readonly vizRenderers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - - return { - registerContext: this.contextContainer.registerContext, - registerVizRenderer: (plugin: PluginOpaqueId, renderMethod: string, renderer: VizTypeRenderer) => - this.vizRenderers.set(renderMethod, this.contextContainer.createHandler(plugin, renderer)), - }; - } - - start(core) { - // Register the core context available to all renderers. Use the VizRendererContext's opaqueId as the first arg. - this.contextContainer.registerContext(this.initContext.opaqueId, 'core', () => ({ - i18n: core.i18n, - uiSettings: core.uiSettings - })); - - return { - registerContext: this.contextContainer.registerContext, - - renderVizualization: (renderMethod: string, domElement: HTMLElement) => { - if (!this.vizRenderer.has(renderMethod)) { - throw new Error(`Render method '${renderMethod}' has not been registered`); - } - - // The handler can now be called directly with only an `HTMLElement` and will automatically - // have a new `context` object created and populated by the context container. - const handler = this.vizRenderers.get(renderMethod) - return handler(domElement); - } - }; - } -} -``` - -## Methods - -| Method | Description | -| --- | --- | -| [createContextContainer()](./kibana-plugin-core-server.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for a service owner. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md deleted file mode 100644 index b9846fa851b35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [analytics](./kibana-plugin-core-server.corepreboot.analytics.md) - -## CorePreboot.analytics property - -[AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) - -Signature: - -```typescript -analytics: AnalyticsServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md deleted file mode 100644 index 7d3b5296b5988..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) - -## CorePreboot.elasticsearch property - -[ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md deleted file mode 100644 index 0df643c6f133b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [http](./kibana-plugin-core-server.corepreboot.http.md) - -## CorePreboot.http property - -[HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) - -Signature: - -```typescript -http: HttpServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.md deleted file mode 100644 index 027dca5362f8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) - -## CorePreboot interface - -Context passed to the `setup` method of `preboot` plugins. - -Signature: - -```typescript -export interface CorePreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.corepreboot.analytics.md) | AnalyticsServicePreboot | [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) | -| [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) | ElasticsearchServicePreboot | [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | -| [http](./kibana-plugin-core-server.corepreboot.http.md) | HttpServicePreboot | [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) | -| [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) | PrebootServicePreboot | [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md deleted file mode 100644 index 3780a92053a5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) - -## CorePreboot.preboot property - -[PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) - -Signature: - -```typescript -preboot: PrebootServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md deleted file mode 100644 index 51d93371e518e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md) - -## CoreRequestHandlerContext.deprecations property - -Signature: - -```typescript -deprecations: { - client: DeprecationsClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md deleted file mode 100644 index 22ff84ce1cb57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md) - -## CoreRequestHandlerContext.elasticsearch property - -Signature: - -```typescript -elasticsearch: { - client: IScopedClusterClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md deleted file mode 100644 index 47297bcddc906..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) - -## CoreRequestHandlerContext interface - -The `core` context provided to route handler. - -Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request - -Signature: - -```typescript -export interface CoreRequestHandlerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md) | { client: DeprecationsClient; } | | -| [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md) | { client: IScopedClusterClient; } | | -| [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md) | { client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; } | | -| [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md) | { client: IUiSettingsClient; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md deleted file mode 100644 index 6d1aa0a8bb5f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md) - -## CoreRequestHandlerContext.savedObjects property - -Signature: - -```typescript -savedObjects: { - client: SavedObjectsClientContract; - typeRegistry: ISavedObjectTypeRegistry; - getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; - getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; - getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md deleted file mode 100644 index f76dcc8965a03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md) - -## CoreRequestHandlerContext.uiSettings property - -Signature: - -```typescript -uiSettings: { - client: IUiSettingsClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md deleted file mode 100644 index 3e6d8a5c2c230..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [analytics](./kibana-plugin-core-server.coresetup.analytics.md) - -## CoreSetup.analytics property - -[AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) - -Signature: - -```typescript -analytics: AnalyticsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md deleted file mode 100644 index 29e66998ab825..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [capabilities](./kibana-plugin-core-server.coresetup.capabilities.md) - -## CoreSetup.capabilities property - -[CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -capabilities: CapabilitiesSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md deleted file mode 100644 index fd8a71f3ff93c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [context](./kibana-plugin-core-server.coresetup.context.md) - -## CoreSetup.context property - -[ContextSetup](./kibana-plugin-core-server.contextsetup.md) - -Signature: - -```typescript -context: ContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md deleted file mode 100644 index 436cc29b6e343..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md) - -## CoreSetup.deprecations property - -[DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) - -Signature: - -```typescript -deprecations: DeprecationsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md deleted file mode 100644 index 68dcc7c9af53f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [docLinks](./kibana-plugin-core-server.coresetup.doclinks.md) - -## CoreSetup.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md deleted file mode 100644 index ed1a87034f51d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) - -## CoreSetup.elasticsearch property - -[ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md deleted file mode 100644 index 847b353aee44f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [executionContext](./kibana-plugin-core-server.coresetup.executioncontext.md) - -## CoreSetup.executionContext property - -[ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) - -Signature: - -```typescript -executionContext: ExecutionContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md deleted file mode 100644 index 1f326449156f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) - -## CoreSetup.getStartServices property - -[StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) - -Signature: - -```typescript -getStartServices: StartServicesAccessor; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md deleted file mode 100644 index a8028827cc0a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [http](./kibana-plugin-core-server.coresetup.http.md) - -## CoreSetup.http property - -[HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) - -Signature: - -```typescript -http: HttpServiceSetup & { - resources: HttpResources; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md deleted file mode 100644 index cac878c1e4449..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [i18n](./kibana-plugin-core-server.coresetup.i18n.md) - -## CoreSetup.i18n property - -[I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) - -Signature: - -```typescript -i18n: I18nServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md deleted file mode 100644 index 78fcc9be2c677..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [logging](./kibana-plugin-core-server.coresetup.logging.md) - -## CoreSetup.logging property - - -Signature: - -```typescript -logging: LoggingServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.md deleted file mode 100644 index cb8d26dc4dda4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) - -## CoreSetup interface - -Context passed to the `setup` method of `standard` plugins. - -Signature: - -```typescript -export interface CoreSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.coresetup.analytics.md) | AnalyticsServiceSetup | [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) | -| [capabilities](./kibana-plugin-core-server.coresetup.capabilities.md) | CapabilitiesSetup | [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [context](./kibana-plugin-core-server.coresetup.context.md) | ContextSetup | [ContextSetup](./kibana-plugin-core-server.contextsetup.md) | -| [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md) | DeprecationsServiceSetup | [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) | -| [docLinks](./kibana-plugin-core-server.coresetup.doclinks.md) | DocLinksServiceSetup | | -| [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) | ElasticsearchServiceSetup | [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) | -| [executionContext](./kibana-plugin-core-server.coresetup.executioncontext.md) | ExecutionContextSetup | [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) | -| [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | StartServicesAccessor<TPluginsStart, TStart> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) | -| [http](./kibana-plugin-core-server.coresetup.http.md) | HttpServiceSetup & { resources: HttpResources; } | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | -| [i18n](./kibana-plugin-core-server.coresetup.i18n.md) | I18nServiceSetup | [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) | -| [logging](./kibana-plugin-core-server.coresetup.logging.md) | LoggingServiceSetup | | -| [metrics](./kibana-plugin-core-server.coresetup.metrics.md) | MetricsServiceSetup | [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | -| [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | SavedObjectsServiceSetup | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) | -| [status](./kibana-plugin-core-server.coresetup.status.md) | StatusServiceSetup | [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) | -| [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) | UiSettingsServiceSetup | [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md deleted file mode 100644 index 77c9e867ef8ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [metrics](./kibana-plugin-core-server.coresetup.metrics.md) - -## CoreSetup.metrics property - -[MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) - -Signature: - -```typescript -metrics: MetricsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md deleted file mode 100644 index 4b448b89bd3cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) - -## CoreSetup.savedObjects property - -[SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) - -Signature: - -```typescript -savedObjects: SavedObjectsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md deleted file mode 100644 index f5ea627a9f008..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [status](./kibana-plugin-core-server.coresetup.status.md) - -## CoreSetup.status property - -[StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) - -Signature: - -```typescript -status: StatusServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md deleted file mode 100644 index 60aff70155a72..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) - -## CoreSetup.uiSettings property - -[UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) - -Signature: - -```typescript -uiSettings: UiSettingsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md b/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md deleted file mode 100644 index 7ea48c183f30e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [analytics](./kibana-plugin-core-server.corestart.analytics.md) - -## CoreStart.analytics property - -[AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) - -Signature: - -```typescript -analytics: AnalyticsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md deleted file mode 100644 index 20705b7554c3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [capabilities](./kibana-plugin-core-server.corestart.capabilities.md) - -## CoreStart.capabilities property - -[CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) - -Signature: - -```typescript -capabilities: CapabilitiesStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md b/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md deleted file mode 100644 index e647d291d9172..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [docLinks](./kibana-plugin-core-server.corestart.doclinks.md) - -## CoreStart.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md deleted file mode 100644 index d8f518ceebd64..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) - -## CoreStart.elasticsearch property - -[ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md b/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md deleted file mode 100644 index e58f4dc4afa32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [executionContext](./kibana-plugin-core-server.corestart.executioncontext.md) - -## CoreStart.executionContext property - -[ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) - -Signature: - -```typescript -executionContext: ExecutionContextStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.http.md b/docs/development/core/server/kibana-plugin-core-server.corestart.http.md deleted file mode 100644 index d81049dfbd340..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [http](./kibana-plugin-core-server.corestart.http.md) - -## CoreStart.http property - -[HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) - -Signature: - -```typescript -http: HttpServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.md b/docs/development/core/server/kibana-plugin-core-server.corestart.md deleted file mode 100644 index f5566e6671ef1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) - -## CoreStart interface - -Context passed to the plugins `start` method. - -Signature: - -```typescript -export interface CoreStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.corestart.analytics.md) | AnalyticsServiceStart | [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) | -| [capabilities](./kibana-plugin-core-server.corestart.capabilities.md) | CapabilitiesStart | [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) | -| [docLinks](./kibana-plugin-core-server.corestart.doclinks.md) | DocLinksServiceStart | | -| [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) | ElasticsearchServiceStart | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | -| [executionContext](./kibana-plugin-core-server.corestart.executioncontext.md) | ExecutionContextStart | [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) | -| [http](./kibana-plugin-core-server.corestart.http.md) | HttpServiceStart | [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) | -| [metrics](./kibana-plugin-core-server.corestart.metrics.md) | MetricsServiceStart | [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) | -| [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) | SavedObjectsServiceStart | [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) | -| [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) | UiSettingsServiceStart | [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md b/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md deleted file mode 100644 index 2c32f730c4c9b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [metrics](./kibana-plugin-core-server.corestart.metrics.md) - -## CoreStart.metrics property - -[MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) - -Signature: - -```typescript -metrics: MetricsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md deleted file mode 100644 index cc31c256df88e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) - -## CoreStart.savedObjects property - -[SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) - -Signature: - -```typescript -savedObjects: SavedObjectsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md deleted file mode 100644 index 95c298820f3c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) - -## CoreStart.uiSettings property - -[UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) - -Signature: - -```typescript -uiSettings: UiSettingsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md deleted file mode 100644 index b41e7020c38e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) > [elasticsearch](./kibana-plugin-core-server.corestatus.elasticsearch.md) - -## CoreStatus.elasticsearch property - -Signature: - -```typescript -elasticsearch: ServiceStatus; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.md deleted file mode 100644 index 8d44ab49dfcb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) - -## CoreStatus interface - -Status of core services. - -Signature: - -```typescript -export interface CoreStatus -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elasticsearch](./kibana-plugin-core-server.corestatus.elasticsearch.md) | ServiceStatus | | -| [savedObjects](./kibana-plugin-core-server.corestatus.savedobjects.md) | ServiceStatus | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md deleted file mode 100644 index d554c6f70d720..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) > [savedObjects](./kibana-plugin-core-server.corestatus.savedobjects.md) - -## CoreStatus.savedObjects property - -Signature: - -```typescript -savedObjects: ServiceStatus; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md deleted file mode 100644 index 0f31a554e2208..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) > [\_shards](./kibana-plugin-core-server.countresponse._shards.md) - -## CountResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md b/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md deleted file mode 100644 index 3cd1a6aaf6644..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) > [count](./kibana-plugin-core-server.countresponse.count.md) - -## CountResponse.count property - -Signature: - -```typescript -count: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse.md b/docs/development/core/server/kibana-plugin-core-server.countresponse.md deleted file mode 100644 index 53793dc87bf33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) - -## CountResponse interface - - -Signature: - -```typescript -export interface CountResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_shards](./kibana-plugin-core-server.countresponse._shards.md) | ShardsInfo | | -| [count](./kibana-plugin-core-server.countresponse.count.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md deleted file mode 100644 index 7668cf56dab83..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) - -## CspConfig.DEFAULT property - -Signature: - -```typescript -static readonly DEFAULT: CspConfig; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md deleted file mode 100644 index bbd7c42c302d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) - -## CspConfig.disableEmbedding property - -Signature: - -```typescript -readonly disableEmbedding: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md deleted file mode 100644 index ebde18e7b3586..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [header](./kibana-plugin-core-server.cspconfig.header.md) - -## CspConfig.header property - -Signature: - -```typescript -readonly header: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.md deleted file mode 100644 index 3d2f4bb683742..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) - -## CspConfig class - -CSP configuration for use in Kibana. - -Signature: - -```typescript -export declare class CspConfig implements ICspConfig -``` -Implements: ICspConfig - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CspConfig` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) | static | CspConfig | | -| [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) | | boolean | | -| [header](./kibana-plugin-core-server.cspconfig.header.md) | | string | | -| [strict](./kibana-plugin-core-server.cspconfig.strict.md) | | boolean | | -| [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) | | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md deleted file mode 100644 index 303d04373db73..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [strict](./kibana-plugin-core-server.cspconfig.strict.md) - -## CspConfig.strict property - -Signature: - -```typescript -readonly strict: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md deleted file mode 100644 index 70c93c57864b7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) - -## CspConfig.warnLegacyBrowsers property - -Signature: - -```typescript -readonly warnLegacyBrowsers: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md deleted file mode 100644 index da37b33fe1bd0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [body](./kibana-plugin-core-server.customhttpresponseoptions.body.md) - -## CustomHttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md deleted file mode 100644 index bbd97ab517d29..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [bypassErrorFormat](./kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md) - -## CustomHttpResponseOptions.bypassErrorFormat property - -Bypass the default error formatting - -Signature: - -```typescript -bypassErrorFormat?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md deleted file mode 100644 index f317037482575..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [headers](./kibana-plugin-core-server.customhttpresponseoptions.headers.md) - -## CustomHttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md deleted file mode 100644 index 84cb55f5c1054..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) - -## CustomHttpResponseOptions interface - -HTTP response parameters for a response with adjustable status code. - -Signature: - -```typescript -export interface CustomHttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.customhttpresponseoptions.body.md) | T | (Optional) HTTP message to send to the client | -| [bypassErrorFormat?](./kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md) | boolean | (Optional) Bypass the default error formatting | -| [headers?](./kibana-plugin-core-server.customhttpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | -| [statusCode](./kibana-plugin-core-server.customhttpresponseoptions.statuscode.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md deleted file mode 100644 index 67cadcb5545a9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [statusCode](./kibana-plugin-core-server.customhttpresponseoptions.statuscode.md) - -## CustomHttpResponseOptions.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md deleted file mode 100644 index afaf8c278565a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md) - -## CustomRequestHandlerContext type - - -Signature: - -```typescript -export declare type CustomRequestHandlerContext = RequestHandlerContext & { - [Key in keyof T]: T[Key] extends Promise ? T[Key] : Promise; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md deleted file mode 100644 index ccc6a76361f26..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md) - -## DeleteDocumentResponse.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md deleted file mode 100644 index a9a04bb2b2ed7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md) - -## DeleteDocumentResponse.\_index property - -Signature: - -```typescript -_index: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md deleted file mode 100644 index e3d5e9208db0a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md) - -## DeleteDocumentResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md deleted file mode 100644 index 690852e20a76e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md) - -## DeleteDocumentResponse.\_type property - -Signature: - -```typescript -_type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md deleted file mode 100644 index acfe8ef55ae71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md) - -## DeleteDocumentResponse.\_version property - -Signature: - -```typescript -_version: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md deleted file mode 100644 index aafe850188998..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [error](./kibana-plugin-core-server.deletedocumentresponse.error.md) - -## DeleteDocumentResponse.error property - -Signature: - -```typescript -error?: { - type: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md deleted file mode 100644 index 00bc89bda66ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [found](./kibana-plugin-core-server.deletedocumentresponse.found.md) - -## DeleteDocumentResponse.found property - -Signature: - -```typescript -found: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md deleted file mode 100644 index fe6712ea3b61c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) - -## DeleteDocumentResponse interface - - -Signature: - -```typescript -export interface DeleteDocumentResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md) | string | | -| [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md) | string | | -| [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md) | ShardsResponse | | -| [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md) | string | | -| [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md) | number | | -| [error?](./kibana-plugin-core-server.deletedocumentresponse.error.md) | { type: string; } | (Optional) | -| [found](./kibana-plugin-core-server.deletedocumentresponse.found.md) | boolean | | -| [result](./kibana-plugin-core-server.deletedocumentresponse.result.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md deleted file mode 100644 index 88f7568d3d9bc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [result](./kibana-plugin-core-server.deletedocumentresponse.result.md) - -## DeleteDocumentResponse.result property - -Signature: - -```typescript -result: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md deleted file mode 100644 index 90cd8daca24cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) > [getAllDeprecations](./kibana-plugin-core-server.deprecationsclient.getalldeprecations.md) - -## DeprecationsClient.getAllDeprecations property - -Signature: - -```typescript -getAllDeprecations: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md deleted file mode 100644 index 0e724e251b266..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) - -## DeprecationsClient interface - -Server-side client that provides access to fetch all Kibana deprecations - -Signature: - -```typescript -export interface DeprecationsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getAllDeprecations](./kibana-plugin-core-server.deprecationsclient.getalldeprecations.md) | () => Promise<DomainDeprecationDetails\[\]> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md deleted file mode 100644 index d8ced1da62416..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) - -## DeprecationsDetails type - - -Signature: - -```typescript -export declare type DeprecationsDetails = ConfigDeprecationDetails | FeatureDeprecationDetails; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md deleted file mode 100644 index 9ad751f8082be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) > [docLinksKey](./kibana-plugin-core-server.deprecationsettings.doclinkskey.md) - -## DeprecationSettings.docLinksKey property - -Key to documentation links - -Signature: - -```typescript -docLinksKey: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md deleted file mode 100644 index 917ca933d63a1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) - -## DeprecationSettings interface - -UiSettings deprecation field options. - -Signature: - -```typescript -export interface DeprecationSettings -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [docLinksKey](./kibana-plugin-core-server.deprecationsettings.doclinkskey.md) | string | Key to documentation links | -| [message](./kibana-plugin-core-server.deprecationsettings.message.md) | string | Deprecation message | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md deleted file mode 100644 index 238600aff4e55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) > [message](./kibana-plugin-core-server.deprecationsettings.message.md) - -## DeprecationSettings.message property - -Deprecation message - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md deleted file mode 100644 index 1fcefeea9b0ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md +++ /dev/null @@ -1,85 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) - -## DeprecationsServiceSetup interface - -The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version. - -The Deprecation service is consumed by the upgrade assistant to assist with the upgrade experience. - -If a deprecated feature can be resolved without manual user intervention. Using correctiveActions.api allows the Upgrade Assistant to use this api to correct the deprecation upon a user trigger. - -Signature: - -```typescript -export interface DeprecationsServiceSetup -``` - -## Example - - -```ts -import { DeprecationsDetails, GetDeprecationsContext, CoreSetup } from 'src/core/server'; -import { i18n } from '@kbn/i18n'; - -async function getDeprecations({ esClient, savedObjectsClient }: GetDeprecationsContext): Promise { - const deprecations: DeprecationsDetails[] = []; - const count = await getFooCount(savedObjectsClient); - if (count > 0) { - deprecations.push({ - title: i18n.translate('xpack.foo.deprecations.title', { - defaultMessage: `Foo's are deprecated` - }), - message: i18n.translate('xpack.foo.deprecations.message', { - defaultMessage: `You have {count} Foo's. Migrate your Foo's to a dashboard to continue using them.`, - values: { count }, - }), - documentationUrl: - 'https://www.elastic.co/guide/en/kibana/current/foo.html', - level: 'warning', - correctiveActions: { - manualSteps: [ - i18n.translate('xpack.foo.deprecations.manualStepOneMessage', { - defaultMessage: 'Navigate to the Kibana Dashboard and click "Create dashboard".', - }), - i18n.translate('xpack.foo.deprecations.manualStepTwoMessage', { - defaultMessage: 'Select Foo from the "New Visualization" window.', - }), - ], - api: { - path: '/internal/security/users/test_dashboard_user', - method: 'POST', - body: { - username: 'test_dashboard_user', - roles: [ - "machine_learning_user", - "enrich_user", - "kibana_admin" - ], - full_name: "Alison Goryachev", - email: "alisongoryachev@gmail.com", - metadata: {}, - enabled: true - } - }, - }, - }); - } - return deprecations; -} - - -export class Plugin() { - setup: (core: CoreSetup) => { - core.deprecations.registerDeprecations({ getDeprecations }); - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [registerDeprecations](./kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md) | (deprecationContext: RegisterDeprecationsConfig) => void | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md deleted file mode 100644 index 07c2a3ad0ce55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) > [registerDeprecations](./kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md) - -## DeprecationsServiceSetup.registerDeprecations property - -Signature: - -```typescript -registerDeprecations: (deprecationContext: RegisterDeprecationsConfig) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md b/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md deleted file mode 100644 index 2c112ac7f6217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) - -## DestructiveRouteMethod type - -Set of HTTP methods changing the state of the server. - -Signature: - -```typescript -export declare type DestructiveRouteMethod = 'post' | 'put' | 'delete' | 'patch'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md deleted file mode 100644 index 1dfb1ab7a0b42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md) - -## ElasticsearchClient type - -Client used to query the elasticsearch cluster. - -Signature: - -```typescript -export declare type ElasticsearchClient = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md deleted file mode 100644 index 2a8a99c17ad63..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchClientConfig](./kibana-plugin-core-server.elasticsearchclientconfig.md) - -## ElasticsearchClientConfig type - -Configuration options to be used to create a [cluster client](./kibana-plugin-core-server.iclusterclient.md) using the [createClient API](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) - -Signature: - -```typescript -export declare type ElasticsearchClientConfig = Pick & { - pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; - requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; - ssl?: Partial; - keepAlive?: boolean; - caFingerprint?: ClientOptions['caFingerprint']; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md deleted file mode 100644 index a8d9f1183b3e5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [(constructor)](./kibana-plugin-core-server.elasticsearchconfig._constructor_.md) - -## ElasticsearchConfig.(constructor) - -Constructs a new instance of the `ElasticsearchConfig` class - -Signature: - -```typescript -constructor(rawConfig: ElasticsearchConfigType); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| rawConfig | ElasticsearchConfigType | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md deleted file mode 100644 index 06ca6a2b9a691..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [apiVersion](./kibana-plugin-core-server.elasticsearchconfig.apiversion.md) - -## ElasticsearchConfig.apiVersion property - -Version of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to. - -Signature: - -```typescript -readonly apiVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md deleted file mode 100644 index 5bc85dfb05647..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [compression](./kibana-plugin-core-server.elasticsearchconfig.compression.md) - -## ElasticsearchConfig.compression property - -Whether to use compression for communications with elasticsearch. - -Signature: - -```typescript -readonly compression: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md deleted file mode 100644 index 93f94687956b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) - -## ElasticsearchConfig.customHeaders property - -Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by `requestHeadersWhitelist` configuration. - -Signature: - -```typescript -readonly customHeaders: ElasticsearchConfigType['customHeaders']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md deleted file mode 100644 index 904168a869d14..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) - -## ElasticsearchConfig.healthCheckDelay property - -The interval between health check requests Kibana sends to the Elasticsearch. - -Signature: - -```typescript -readonly healthCheckDelay: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md deleted file mode 100644 index f702512287c1c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) - -## ElasticsearchConfig.hosts property - -Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. - -Signature: - -```typescript -readonly hosts: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md deleted file mode 100644 index 9d708f28a66c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) - -## ElasticsearchConfig.ignoreVersionMismatch property - -Whether to allow kibana to connect to a non-compatible elasticsearch node. - -Signature: - -```typescript -readonly ignoreVersionMismatch: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md deleted file mode 100644 index 64403f0cad543..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [maxSockets](./kibana-plugin-core-server.elasticsearchconfig.maxsockets.md) - -## ElasticsearchConfig.maxSockets property - -The maximum number of sockets that can be used for communications with elasticsearch. - -Signature: - -```typescript -readonly maxSockets: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md deleted file mode 100644 index 593836664d5bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) - -## ElasticsearchConfig class - -Wrapper of config schema. - -Signature: - -```typescript -export declare class ElasticsearchConfig -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(rawConfig)](./kibana-plugin-core-server.elasticsearchconfig._constructor_.md) | | Constructs a new instance of the ElasticsearchConfig class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [apiVersion](./kibana-plugin-core-server.elasticsearchconfig.apiversion.md) | | string | Version of the Elasticsearch (6.7, 7.1 or master) client will be connecting to. | -| [compression](./kibana-plugin-core-server.elasticsearchconfig.compression.md) | | boolean | Whether to use compression for communications with elasticsearch. | -| [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) | | ElasticsearchConfigType\['customHeaders'\] | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by requestHeadersWhitelist configuration. | -| [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) | | Duration | The interval between health check requests Kibana sends to the Elasticsearch. | -| [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) | | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. | -| [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) | | boolean | Whether to allow kibana to connect to a non-compatible elasticsearch node. | -| [maxSockets](./kibana-plugin-core-server.elasticsearchconfig.maxsockets.md) | | number | The maximum number of sockets that can be used for communications with elasticsearch. | -| [password?](./kibana-plugin-core-server.elasticsearchconfig.password.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. | -| [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) | | Duration | Timeout after which PING HTTP request will be aborted and retried. | -| [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) | | string\[\] | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. | -| [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) | | Duration | Timeout after which HTTP request will be aborted and retried. | -| [serviceAccountToken?](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) | | string | (Optional) If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions.This is an alternative to specifying a username and password. | -| [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) | | Duration | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. | -| [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) | | false \| Duration | Interval to perform a sniff operation and make sure the list of nodes is complete. If false then sniffing is disabled. | -| [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) | | boolean | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. | -| [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) | | boolean | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. | -| [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) | | Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' \| 'keystore' \| 'truststore'>> & { certificateAuthorities?: string\[\]; } | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full. | -| [username?](./kibana-plugin-core-server.elasticsearchconfig.username.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md deleted file mode 100644 index 2f927b5bc7c76..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [password](./kibana-plugin-core-server.elasticsearchconfig.password.md) - -## ElasticsearchConfig.password property - -If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. - -Signature: - -```typescript -readonly password?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md deleted file mode 100644 index 07e37974219de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) - -## ElasticsearchConfig.pingTimeout property - -Timeout after which PING HTTP request will be aborted and retried. - -Signature: - -```typescript -readonly pingTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md deleted file mode 100644 index c19dcd3896366..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) - -## ElasticsearchConfig.requestHeadersWhitelist property - -List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. - -Signature: - -```typescript -readonly requestHeadersWhitelist: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md deleted file mode 100644 index f43cfc754b1f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) - -## ElasticsearchConfig.requestTimeout property - -Timeout after which HTTP request will be aborted and retried. - -Signature: - -```typescript -readonly requestTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md deleted file mode 100644 index 5934e83de17a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [serviceAccountToken](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) - -## ElasticsearchConfig.serviceAccountToken property - -If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions. - -This is an alternative to specifying a username and password. - -Signature: - -```typescript -readonly serviceAccountToken?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md deleted file mode 100644 index c29f00a074e3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) - -## ElasticsearchConfig.shardTimeout property - -Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. - -Signature: - -```typescript -readonly shardTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md deleted file mode 100644 index 19f6968b13863..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) - -## ElasticsearchConfig.sniffInterval property - -Interval to perform a sniff operation and make sure the list of nodes is complete. If `false` then sniffing is disabled. - -Signature: - -```typescript -readonly sniffInterval: false | Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md deleted file mode 100644 index a632b446a55fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) - -## ElasticsearchConfig.sniffOnConnectionFault property - -Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. - -Signature: - -```typescript -readonly sniffOnConnectionFault: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md deleted file mode 100644 index 09f3431c71880..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) - -## ElasticsearchConfig.sniffOnStart property - -Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. - -Signature: - -```typescript -readonly sniffOnStart: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md deleted file mode 100644 index f88fc57339475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) - -## ElasticsearchConfig.ssl property - -Set of settings configure SSL connection between Kibana and Elasticsearch that are required when `xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`. - -Signature: - -```typescript -readonly ssl: Pick> & { - certificateAuthorities?: string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md deleted file mode 100644 index 959870ff43a0f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [username](./kibana-plugin-core-server.elasticsearchconfig.username.md) - -## ElasticsearchConfig.username property - -If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. - -Signature: - -```typescript -readonly username?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md deleted file mode 100644 index df99d5ec4b831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) > [credentialsSpecified](./kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md) - -## ElasticsearchConfigPreboot.credentialsSpecified property - -Indicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`). - -Signature: - -```typescript -readonly credentialsSpecified: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md deleted file mode 100644 index e9ad47b61419e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) > [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) - -## ElasticsearchConfigPreboot.hosts property - -Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. - -Signature: - -```typescript -readonly hosts: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md deleted file mode 100644 index d7d3e8d70e8d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) - -## ElasticsearchConfigPreboot interface - -A limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`. - -Signature: - -```typescript -export interface ElasticsearchConfigPreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [credentialsSpecified](./kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md) | boolean | Indicates whether Elasticsearch configuration includes credentials (username, password or serviceAccountToken). | -| [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md deleted file mode 100644 index 7191caea54929..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) > [error](./kibana-plugin-core-server.elasticsearcherrordetails.error.md) - -## ElasticsearchErrorDetails.error property - -Signature: - -```typescript -error?: { - type: string; - reason?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md deleted file mode 100644 index 570a161db20e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) - -## ElasticsearchErrorDetails interface - - -Signature: - -```typescript -export interface ElasticsearchErrorDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error?](./kibana-plugin-core-server.elasticsearcherrordetails.error.md) | { type: string; reason?: string; } | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md deleted file mode 100644 index c4284248ea894..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) - -## ElasticsearchServicePreboot.config property - -A limited set of Elasticsearch configuration entries. - -Signature: - -```typescript -readonly config: Readonly; -``` - -## Example - - -```js -const { hosts, credentialsSpecified } = core.elasticsearch.config; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md deleted file mode 100644 index 070cb7905b585..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) - -## ElasticsearchServicePreboot.createClient property - -Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). - -Signature: - -```typescript -readonly createClient: (type: string, clientConfig?: Partial) => ICustomClusterClient; -``` - -## Example - - -```js -const client = elasticsearch.createClient('my-app-name', config); -const data = await client.asInternalUser.search(); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md deleted file mode 100644 index 14dc099d13835..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) - -## ElasticsearchServicePreboot interface - - -Signature: - -```typescript -export interface ElasticsearchServicePreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) | Readonly<ElasticsearchConfigPreboot> | A limited set of Elasticsearch configuration entries. | -| [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md deleted file mode 100644 index 03e2be0da7a10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) > [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) - -## ElasticsearchServiceSetup.legacy property - -> Warning: This API is now obsolete. -> -> - -Signature: - -```typescript -legacy: { - readonly config$: Observable; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md deleted file mode 100644 index f66333427a224..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) - -## ElasticsearchServiceSetup interface - - -Signature: - -```typescript -export interface ElasticsearchServiceSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) | { readonly config$: Observable<ElasticsearchConfig>; } | | -| [setUnauthorizedErrorHandler](./kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md) | (handler: UnauthorizedErrorHandler) => void | Register a handler that will be called when unauthorized (401) errors are returned from any API call to elasticsearch performed on behalf of a user via a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md deleted file mode 100644 index ee403a800d934..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) > [setUnauthorizedErrorHandler](./kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md) - -## ElasticsearchServiceSetup.setUnauthorizedErrorHandler property - -Register a handler that will be called when unauthorized (401) errors are returned from any API call to elasticsearch performed on behalf of a user via a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md). - -Signature: - -```typescript -setUnauthorizedErrorHandler: (handler: UnauthorizedErrorHandler) => void; -``` - -## Remarks - -The handler will only be invoked for scoped client bound to real [request](./kibana-plugin-core-server.kibanarequest.md) instances. - -## Example - - -```ts -const handler: UnauthorizedErrorHandler = ({ request, error }, toolkit) => { - const reauthenticationResult = await authenticator.reauthenticate(request, error); - if (reauthenticationResult.succeeded()) { - return toolkit.retry({ - authHeaders: reauthenticationResult.authHeaders, - }); - } - return toolkit.notHandled(); -} - -coreSetup.elasticsearch.setUnauthorizedErrorHandler(handler); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md deleted file mode 100644 index 59f302170c53a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [client](./kibana-plugin-core-server.elasticsearchservicestart.client.md) - -## ElasticsearchServiceStart.client property - -A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) - -Signature: - -```typescript -readonly client: IClusterClient; -``` - -## Example - - -```js -const client = core.elasticsearch.client; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md deleted file mode 100644 index 26930c6f02b32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) - -## ElasticsearchServiceStart.createClient property - -Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). - -Signature: - -```typescript -readonly createClient: (type: string, clientConfig?: Partial) => ICustomClusterClient; -``` - -## Example - - -```js -const client = elasticsearch.createClient('my-app-name', config); -const data = await client.asInternalUser.search(); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md deleted file mode 100644 index 66ff94ee9c80d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) - -## ElasticsearchServiceStart interface - - -Signature: - -```typescript -export interface ElasticsearchServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.elasticsearchservicestart.client.md) | IClusterClient | A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) | -| [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md deleted file mode 100644 index f8a45fe9a5a9c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) - -## ElasticsearchStatusMeta.incompatibleNodes property - -Signature: - -```typescript -incompatibleNodes: NodesVersionCompatibility['incompatibleNodes']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md deleted file mode 100644 index 82748932c2102..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) - -## ElasticsearchStatusMeta interface - - -Signature: - -```typescript -export interface ElasticsearchStatusMeta -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) | NodesVersionCompatibility\['incompatibleNodes'\] | | -| [nodesInfoRequestError?](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) | NodesVersionCompatibility\['nodesInfoRequestError'\] | (Optional) | -| [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) | NodesVersionCompatibility\['warningNodes'\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md deleted file mode 100644 index 1b46078a1a453..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [nodesInfoRequestError](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) - -## ElasticsearchStatusMeta.nodesInfoRequestError property - -Signature: - -```typescript -nodesInfoRequestError?: NodesVersionCompatibility['nodesInfoRequestError']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md deleted file mode 100644 index 7374ccd9e7fa8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) - -## ElasticsearchStatusMeta.warningNodes property - -Signature: - -```typescript -warningNodes: NodesVersionCompatibility['warningNodes']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md deleted file mode 100644 index 102e0c8f64b5a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) > [body](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) - -## ErrorHttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: ResponseError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md deleted file mode 100644 index bbd91156347b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) > [headers](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) - -## ErrorHttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md deleted file mode 100644 index 3a037e71ac1e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) - -## ErrorHttpResponseOptions interface - -HTTP response parameters - -Signature: - -```typescript -export interface ErrorHttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) | ResponseError | (Optional) HTTP message to send to the client | -| [headers?](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md deleted file mode 100644 index ae9df8b406be6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [(constructor)](./kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md) - -## EventLoopDelaysMonitor.(constructor) - -Creating a new instance from EventLoopDelaysMonitor will automatically start tracking event loop delays. - -Signature: - -```typescript -constructor(); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md deleted file mode 100644 index ff9c57787f71d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [collect](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) - -## EventLoopDelaysMonitor.collect() method - -Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time `reset` was called or this EventLoopDelaysMonitor instance was created. - -Returns metrics in milliseconds. - -Signature: - -```typescript -collect(): IntervalHistogram; -``` -Returns: - -IntervalHistogram - -{IntervalHistogram} - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md deleted file mode 100644 index e5d35547d3bdb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) - -## EventLoopDelaysMonitor class - -Signature: - -```typescript -export declare class EventLoopDelaysMonitor -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)()](./kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md) | | Creating a new instance from EventLoopDelaysMonitor will automatically start tracking event loop delays. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [collect()](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) | | Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time reset was called or this EventLoopDelaysMonitor instance was created.Returns metrics in milliseconds. | -| [reset()](./kibana-plugin-core-server.eventloopdelaysmonitor.reset.md) | | Resets the collected histogram data. | -| [stop()](./kibana-plugin-core-server.eventloopdelaysmonitor.stop.md) | | Disables updating the interval timer for collecting new data points. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md deleted file mode 100644 index a65cc7c99842d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [reset](./kibana-plugin-core-server.eventloopdelaysmonitor.reset.md) - -## EventLoopDelaysMonitor.reset() method - -Resets the collected histogram data. - -Signature: - -```typescript -reset(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md deleted file mode 100644 index d63c963b384e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [stop](./kibana-plugin-core-server.eventloopdelaysmonitor.stop.md) - -## EventLoopDelaysMonitor.stop() method - -Disables updating the interval timer for collecting new data points. - -Signature: - -```typescript -stop(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md deleted file mode 100644 index c8816a3deee4d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) > [getAsLabels](./kibana-plugin-core-server.executioncontextsetup.getaslabels.md) - -## ExecutionContextSetup.getAsLabels() method - -Signature: - -```typescript -getAsLabels(): apm.Labels; -``` -Returns: - -apm.Labels - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md deleted file mode 100644 index 7fdc4d1ec1d57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) - -## ExecutionContextSetup interface - - -Signature: - -```typescript -export interface ExecutionContextSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getAsLabels()](./kibana-plugin-core-server.executioncontextsetup.getaslabels.md) | | -| [withContext(context, fn)](./kibana-plugin-core-server.executioncontextsetup.withcontext.md) | Keeps track of execution context while the passed function is executed. Data are carried over all async operations spawned by the passed function. The nested calls stack the registered context on top of each other. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md deleted file mode 100644 index 2bfef6db2f907..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) > [withContext](./kibana-plugin-core-server.executioncontextsetup.withcontext.md) - -## ExecutionContextSetup.withContext() method - -Keeps track of execution context while the passed function is executed. Data are carried over all async operations spawned by the passed function. The nested calls stack the registered context on top of each other. - -Signature: - -```typescript -withContext(context: KibanaExecutionContext | undefined, fn: (...args: any[]) => R): R; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | KibanaExecutionContext \| undefined | | -| fn | (...args: any\[\]) => R | | - -Returns: - -R - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md deleted file mode 100644 index 115c09471b3f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) - -## ExecutionContextStart type - - -Signature: - -```typescript -export declare type ExecutionContextStart = ExecutionContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md b/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md deleted file mode 100644 index b2bb3f5928dcc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExposedToBrowserDescriptor](./kibana-plugin-core-server.exposedtobrowserdescriptor.md) - -## ExposedToBrowserDescriptor type - -Type defining the list of configuration properties that will be exposed on the client-side Object properties can either be fully exposed - -Signature: - -```typescript -export declare type ExposedToBrowserDescriptor = { - [Key in keyof T]?: T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? // can be nested for objects - ExposedToBrowserDescriptor | boolean : boolean; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md b/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md deleted file mode 100644 index 55d1dc7edc05e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FakeRequest](./kibana-plugin-core-server.fakerequest.md) > [headers](./kibana-plugin-core-server.fakerequest.headers.md) - -## FakeRequest.headers property - -Headers used for authentication against Elasticsearch - -Signature: - -```typescript -headers: Headers; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.fakerequest.md b/docs/development/core/server/kibana-plugin-core-server.fakerequest.md deleted file mode 100644 index 6b8bfe33d19c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.fakerequest.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FakeRequest](./kibana-plugin-core-server.fakerequest.md) - -## FakeRequest interface - -Fake request object created manually by Kibana plugins. - -Signature: - -```typescript -export interface FakeRequest -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers](./kibana-plugin-core-server.fakerequest.headers.md) | Headers | Headers used for authentication against Elasticsearch | - diff --git a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md deleted file mode 100644 index b530874d3678b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md) - -## FeatureDeprecationDetails.deprecationType property - -Signature: - -```typescript -deprecationType?: 'feature' | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md deleted file mode 100644 index c92f352ce7e5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) - -## FeatureDeprecationDetails interface - - -Signature: - -```typescript -export interface FeatureDeprecationDetails extends BaseDeprecationDetails -``` -Extends: BaseDeprecationDetails - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecationType?](./kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md) | 'feature' \| undefined | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md b/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md deleted file mode 100644 index 2f1502a5ea0ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetAuthHeaders](./kibana-plugin-core-server.getauthheaders.md) - -## GetAuthHeaders type - -Get headers to authenticate a user against Elasticsearch. - -Signature: - -```typescript -export declare type GetAuthHeaders = (request: KibanaRequest) => AuthHeaders | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getauthstate.md b/docs/development/core/server/kibana-plugin-core-server.getauthstate.md deleted file mode 100644 index 979a6b5b5792b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getauthstate.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetAuthState](./kibana-plugin-core-server.getauthstate.md) - -## GetAuthState type - -Gets authentication state for a request. Returned by `auth` interceptor. - -Signature: - -```typescript -export declare type GetAuthState = (request: KibanaRequest) => { - status: AuthStatus; - state: T; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md deleted file mode 100644 index 70c1864bf905f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) > [esClient](./kibana-plugin-core-server.getdeprecationscontext.esclient.md) - -## GetDeprecationsContext.esClient property - -Signature: - -```typescript -esClient: IScopedClusterClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md deleted file mode 100644 index 2362966866852..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) - -## GetDeprecationsContext interface - - -Signature: - -```typescript -export interface GetDeprecationsContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [esClient](./kibana-plugin-core-server.getdeprecationscontext.esclient.md) | IScopedClusterClient | | -| [savedObjectsClient](./kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md) | SavedObjectsClientContract | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md deleted file mode 100644 index 66da52d3b5824..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) > [savedObjectsClient](./kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md) - -## GetDeprecationsContext.savedObjectsClient property - -Signature: - -```typescript -savedObjectsClient: SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md deleted file mode 100644 index d31b61f3962c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_id](./kibana-plugin-core-server.getresponse._id.md) - -## GetResponse.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md deleted file mode 100644 index 0353ec1a17b2c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_index](./kibana-plugin-core-server.getresponse._index.md) - -## GetResponse.\_index property - -Signature: - -```typescript -_index: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md deleted file mode 100644 index 8412302ab727d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md) - -## GetResponse.\_primary\_term property - -Signature: - -```typescript -_primary_term: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md deleted file mode 100644 index 1af3ed31ee112..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_routing](./kibana-plugin-core-server.getresponse._routing.md) - -## GetResponse.\_routing property - -Signature: - -```typescript -_routing?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md deleted file mode 100644 index e8d72563f8149..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md) - -## GetResponse.\_seq\_no property - -Signature: - -```typescript -_seq_no: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md deleted file mode 100644 index 97aacb42992a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_source](./kibana-plugin-core-server.getresponse._source.md) - -## GetResponse.\_source property - -Signature: - -```typescript -_source: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md deleted file mode 100644 index b3205e2fe91d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_type](./kibana-plugin-core-server.getresponse._type.md) - -## GetResponse.\_type property - -Signature: - -```typescript -_type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md deleted file mode 100644 index 23d3a8c91f4a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_version](./kibana-plugin-core-server.getresponse._version.md) - -## GetResponse.\_version property - -Signature: - -```typescript -_version: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md b/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md deleted file mode 100644 index 8d34a3e743cca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [found](./kibana-plugin-core-server.getresponse.found.md) - -## GetResponse.found property - -Signature: - -```typescript -found: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse.md b/docs/development/core/server/kibana-plugin-core-server.getresponse.md deleted file mode 100644 index 5068be8a5689a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) - -## GetResponse interface - - -Signature: - -```typescript -export interface GetResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.getresponse._id.md) | string | | -| [\_index](./kibana-plugin-core-server.getresponse._index.md) | string | | -| [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md) | number | | -| [\_routing?](./kibana-plugin-core-server.getresponse._routing.md) | string | (Optional) | -| [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md) | number | | -| [\_source](./kibana-plugin-core-server.getresponse._source.md) | T | | -| [\_type](./kibana-plugin-core-server.getresponse._type.md) | string | | -| [\_version](./kibana-plugin-core-server.getresponse._version.md) | number | | -| [found](./kibana-plugin-core-server.getresponse.found.md) | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md b/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md deleted file mode 100644 index 6fef414209d71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md) - -## HandlerContextType type - -Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) to represent the type of the context. - -Signature: - -```typescript -export declare type HandlerContextType> = T extends HandlerFunction ? U : never; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md b/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md deleted file mode 100644 index 2b41e5a978be2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) - -## HandlerFunction type - -A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) - -Signature: - -```typescript -export declare type HandlerFunction = (context: T, ...args: any[]) => any; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md b/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md deleted file mode 100644 index 3e5a2f24eddc7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) - -## HandlerParameters type - -Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md), excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md). - -Signature: - -```typescript -export declare type HandlerParameters> = T extends (context: any, ...args: infer U) => any ? U : never; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.headers_2.md b/docs/development/core/server/kibana-plugin-core-server.headers_2.md deleted file mode 100644 index 398827f2bf3d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.headers_2.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Headers\_2](./kibana-plugin-core-server.headers_2.md) - -## Headers\_2 type - -Http request headers to read. - -Signature: - -```typescript -export declare type Headers = { - [header in KnownHeaders]?: string | string[] | undefined; -} & { - [header: string]: string | string[] | undefined; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md deleted file mode 100644 index 4ea67cf895a27..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) > [get](./kibana-plugin-core-server.httpauth.get.md) - -## HttpAuth.get property - -Gets authentication state for a request. Returned by `auth` interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) - -Signature: - -```typescript -get: GetAuthState; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md deleted file mode 100644 index 54db6bce5f161..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) > [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) - -## HttpAuth.isAuthenticated property - -Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) - -Signature: - -```typescript -isAuthenticated: IsAuthenticated; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.md deleted file mode 100644 index 4b47be615c79c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) - -## HttpAuth interface - - -Signature: - -```typescript -export interface HttpAuth -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-server.httpauth.get.md) | GetAuthState | Gets authentication state for a request. Returned by auth interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) | -| [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) | IsAuthenticated | Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.md deleted file mode 100644 index 0b1854d7cbcd9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresources.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResources](./kibana-plugin-core-server.httpresources.md) - -## HttpResources interface - -HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. - -Signature: - -```typescript -export interface HttpResources -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [register](./kibana-plugin-core-server.httpresources.register.md) | <P, Q, B, Context extends RequestHandlerContext = RequestHandlerContext>(route: RouteConfig<P, Q, B, 'get'>, handler: HttpResourcesRequestHandler<P, Q, B, Context>) => void | To register a route handler executing passed function to form response. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md deleted file mode 100644 index ee9569aeb37b4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResources](./kibana-plugin-core-server.httpresources.md) > [register](./kibana-plugin-core-server.httpresources.register.md) - -## HttpResources.register property - -To register a route handler executing passed function to form response. - -Signature: - -```typescript -register: (route: RouteConfig, handler: HttpResourcesRequestHandler) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md deleted file mode 100644 index bb6dec504ff42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) > [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) - -## HttpResourcesRenderOptions.headers property - -HTTP Headers with additional information about response. - -Signature: - -```typescript -headers?: ResponseHeaders; -``` - -## Remarks - -All HTML pages are already pre-configured with `content-security-policy` header that cannot be overridden. - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md deleted file mode 100644 index 9fcdc1b338783..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) - -## HttpResourcesRenderOptions interface - -Allows to configure HTTP response parameters - -Signature: - -```typescript -export interface HttpResourcesRenderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers?](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md deleted file mode 100644 index 49854ac003860..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) - -## HttpResourcesRequestHandler type - -Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. - -Signature: - -```typescript -export declare type HttpResourcesRequestHandler

= RequestHandler; -``` - -## Example - -\`\`\`typescript httpResources.register({ path: '/login', validate: { params: schema.object({ id: schema.string() }), }, }, async (context, request, response) => { //.. return response.renderCoreApp(); }); - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md deleted file mode 100644 index 2ea3ea7e58c78..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) - -## HttpResourcesResponseOptions type - -HTTP Resources response parameters - -Signature: - -```typescript -export declare type HttpResourcesResponseOptions = HttpResponseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md deleted file mode 100644 index 05e7af5dcbedf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) - -## HttpResourcesServiceToolkit interface - -Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. - -Signature: - -```typescript -export interface HttpResourcesServiceToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. | -| [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application. | -| [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom HTML page. | -| [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom JS script file. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md deleted file mode 100644 index 3dce9d88c8036..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) - -## HttpResourcesServiceToolkit.renderAnonymousCoreApp property - -To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. - -Signature: - -```typescript -renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md deleted file mode 100644 index eb4f095bc19be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) - -## HttpResourcesServiceToolkit.renderCoreApp property - -To respond with HTML page bootstrapping Kibana application. - -Signature: - -```typescript -renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md deleted file mode 100644 index 325d19625df44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) - -## HttpResourcesServiceToolkit.renderHtml property - -To respond with a custom HTML page. - -Signature: - -```typescript -renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md deleted file mode 100644 index f8d4418fc6cba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) - -## HttpResourcesServiceToolkit.renderJs property - -To respond with a custom JS script file. - -Signature: - -```typescript -renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md deleted file mode 100644 index bf61be9d7e606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [body](./kibana-plugin-core-server.httpresponseoptions.body.md) - -## HttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: HttpResponsePayload; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md deleted file mode 100644 index 98792c47d564f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [bypassErrorFormat](./kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md) - -## HttpResponseOptions.bypassErrorFormat property - -Bypass the default error formatting - -Signature: - -```typescript -bypassErrorFormat?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md deleted file mode 100644 index 7702c49d07c8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [headers](./kibana-plugin-core-server.httpresponseoptions.headers.md) - -## HttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md deleted file mode 100644 index 9d10d91244157..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) - -## HttpResponseOptions interface - -HTTP response parameters - -Signature: - -```typescript -export interface HttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.httpresponseoptions.body.md) | HttpResponsePayload | (Optional) HTTP message to send to the client | -| [bypassErrorFormat?](./kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md) | boolean | (Optional) Bypass the default error formatting | -| [headers?](./kibana-plugin-core-server.httpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md b/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md deleted file mode 100644 index 8f72dc4daa8a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) - -## HttpResponsePayload type - -Data send to the client as a response payload. - -Signature: - -```typescript -export declare type HttpResponsePayload = undefined | string | Record | Buffer | Stream; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md deleted file mode 100644 index 194a8aea16269..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [hostname](./kibana-plugin-core-server.httpserverinfo.hostname.md) - -## HttpServerInfo.hostname property - -The hostname of the server - -Signature: - -```typescript -hostname: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md deleted file mode 100644 index 151cb5d272403..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) - -## HttpServerInfo interface - -Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md). - -Signature: - -```typescript -export interface HttpServerInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hostname](./kibana-plugin-core-server.httpserverinfo.hostname.md) | string | The hostname of the server | -| [name](./kibana-plugin-core-server.httpserverinfo.name.md) | string | The name of the Kibana server | -| [port](./kibana-plugin-core-server.httpserverinfo.port.md) | number | The port the server is listening on | -| [protocol](./kibana-plugin-core-server.httpserverinfo.protocol.md) | 'http' \| 'https' \| 'socket' | The protocol used by the server | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md deleted file mode 100644 index c35ed626f12c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [name](./kibana-plugin-core-server.httpserverinfo.name.md) - -## HttpServerInfo.name property - -The name of the Kibana server - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md deleted file mode 100644 index e8ad0e8186fea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [port](./kibana-plugin-core-server.httpserverinfo.port.md) - -## HttpServerInfo.port property - -The port the server is listening on - -Signature: - -```typescript -port: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md deleted file mode 100644 index 9e7c672c2361f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [protocol](./kibana-plugin-core-server.httpserverinfo.protocol.md) - -## HttpServerInfo.protocol property - -The protocol used by the server - -Signature: - -```typescript -protocol: 'http' | 'https' | 'socket'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md deleted file mode 100644 index 9864f67d70a43..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [basePath](./kibana-plugin-core-server.httpservicepreboot.basepath.md) - -## HttpServicePreboot.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md deleted file mode 100644 index 0c9636b8eb634..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [getServerInfo](./kibana-plugin-core-server.httpservicepreboot.getserverinfo.md) - -## HttpServicePreboot.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running preboot http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md deleted file mode 100644 index 87c62b63014e1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md +++ /dev/null @@ -1,80 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) - -## HttpServicePreboot interface - -Kibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality allows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins can define HTTP routes at this stage. - -Signature: - -```typescript -export interface HttpServicePreboot -``` - -## Example - -To handle an incoming request in your preboot plugin you should: - Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. To opt out of validating the request, specify `false`. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; -``` -- Declare a function to respond to incoming request. The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. Any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. - -```ts -const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { - const data = await findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) { - return response.notFound(); - } - // creates a command to send found data to the client and set response headers - return response.ok({ - body: data, - headers: { 'content-type': 'application/json' } - }); -} -``` -\* - Acquire `preboot` [IRouter](./kibana-plugin-core-server.irouter.md) instance and register route handler for GET request to 'path/{id}' path. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; - -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; - -httpPreboot.registerRoutes('my-plugin', (router) => { - router.get({ path: 'path/{id}', validate }, async (context, request, response) => { - const data = await findObject(request.params.id); - if (!data) { - return response.notFound(); - } - return response.ok({ - body: data, - headers: { 'content-type': 'application/json' } - }); - }); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [basePath](./kibana-plugin-core-server.httpservicepreboot.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [getServerInfo](./kibana-plugin-core-server.httpservicepreboot.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running preboot http server. | - -## Methods - -| Method | Description | -| --- | --- | -| [registerRoutes(path, callback)](./kibana-plugin-core-server.httpservicepreboot.registerroutes.md) | Provides ability to acquire preboot [IRouter](./kibana-plugin-core-server.irouter.md) instance for a particular top-level path and register handler functions for any number of nested routes. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md deleted file mode 100644 index dd90074fad39a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [registerRoutes](./kibana-plugin-core-server.httpservicepreboot.registerroutes.md) - -## HttpServicePreboot.registerRoutes() method - -Provides ability to acquire `preboot` [IRouter](./kibana-plugin-core-server.irouter.md) instance for a particular top-level path and register handler functions for any number of nested routes. - -Signature: - -```typescript -registerRoutes(path: string, callback: (router: IRouter) => void): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | -| callback | (router: IRouter) => void | | - -Returns: - -void - -## Remarks - -Each route can have only one handler function, which is executed when the route is matched. See the [IRouter](./kibana-plugin-core-server.irouter.md) documentation for more information. - -## Example - - -```ts -registerRoutes('my-plugin', (router) => { - // handler is called when '/my-plugin/path' resource is requested with `GET` method - router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); -}); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md deleted file mode 100644 index ba10af1b8555a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [basePath](./kibana-plugin-core-server.httpservicesetup.basepath.md) - -## HttpServiceSetup.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md deleted file mode 100644 index bdc0acf1c4864..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [createCookieSessionStorageFactory](./kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md) - -## HttpServiceSetup.createCookieSessionStorageFactory property - -Creates cookie based session storage factory [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) - -Signature: - -```typescript -createCookieSessionStorageFactory: (cookieOptions: SessionStorageCookieOptions) => Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md deleted file mode 100644 index 7bdc7cd2e4e33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [createRouter](./kibana-plugin-core-server.httpservicesetup.createrouter.md) - -## HttpServiceSetup.createRouter property - -Provides ability to declare a handler function for a particular path and HTTP request method. - -Signature: - -```typescript -createRouter: () => IRouter; -``` - -## Remarks - -Each route can have only one handler function, which is executed when the route is matched. See the [IRouter](./kibana-plugin-core-server.irouter.md) documentation for more information. - -## Example - - -```ts -const router = createRouter(); -// handler is called when '/path' resource is requested with `GET` method -router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md deleted file mode 100644 index 1e2b987e667c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [csp](./kibana-plugin-core-server.httpservicesetup.csp.md) - -## HttpServiceSetup.csp property - -The CSP config used for Kibana. - -Signature: - -```typescript -csp: ICspConfig; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md deleted file mode 100644 index 9e257062722a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [getServerInfo](./kibana-plugin-core-server.httpservicesetup.getserverinfo.md) - -## HttpServiceSetup.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md deleted file mode 100644 index bb03887e547e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md +++ /dev/null @@ -1,91 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) - -## HttpServiceSetup interface - -Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to `hapi` server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. - -Signature: - -```typescript -export interface HttpServiceSetup -``` - -## Example - -To handle an incoming request in your plugin you should: - Create a `Router` instance. - -```ts -const router = httpSetup.createRouter(); -``` -- Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. To opt out of validating the request, specify `false`. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; -``` -- Declare a function to respond to incoming request. The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. Unlike, `hapi` route handler in the Legacy platform, any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. - -```ts -const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { - const data = await findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) return response.notFound(); - // creates a command to send found data to the client and set response headers - return response.ok({ - body: data, - headers: { - 'content-type': 'application/json' - } - }); -} -``` -- Register route handler for GET request to 'path/{id}' path - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const router = httpSetup.createRouter(); - -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; - -router.get({ - path: 'path/{id}', - validate -}, -async (context, request, response) => { - const data = await findObject(request.params.id); - if (!data) return response.notFound(); - return response.ok({ - body: data, - headers: { - 'content-type': 'application/json' - } - }); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [basePath](./kibana-plugin-core-server.httpservicesetup.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [createCookieSessionStorageFactory](./kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md) | <T>(cookieOptions: SessionStorageCookieOptions<T>) => Promise<SessionStorageFactory<T>> | Creates cookie based session storage factory [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) | -| [createRouter](./kibana-plugin-core-server.httpservicesetup.createrouter.md) | <Context extends RequestHandlerContext = RequestHandlerContext>() => IRouter<Context> | Provides ability to declare a handler function for a particular path and HTTP request method. | -| [csp](./kibana-plugin-core-server.httpservicesetup.csp.md) | ICspConfig | The CSP config used for Kibana. | -| [getServerInfo](./kibana-plugin-core-server.httpservicesetup.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. | -| [registerAuth](./kibana-plugin-core-server.httpservicesetup.registerauth.md) | (handler: AuthenticationHandler) => void | To define custom authentication and/or authorization mechanism for incoming requests. | -| [registerOnPostAuth](./kibana-plugin-core-server.httpservicesetup.registeronpostauth.md) | (handler: OnPostAuthHandler) => void | To define custom logic after Auth interceptor did make sure a user has access to the requested resource. | -| [registerOnPreAuth](./kibana-plugin-core-server.httpservicesetup.registeronpreauth.md) | (handler: OnPreAuthHandler) => void | To define custom logic to perform for incoming requests before the Auth interceptor performs a check that user has access to requested resources. | -| [registerOnPreResponse](./kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md) | (handler: OnPreResponseHandler) => void | To define custom logic to perform for the server response. | -| [registerOnPreRouting](./kibana-plugin-core-server.httpservicesetup.registeronprerouting.md) | (handler: OnPreRoutingHandler) => void | To define custom logic to perform for incoming requests before server performs a route lookup. | -| [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) | <Context extends RequestHandlerContext, ContextName extends keyof Omit<Context, 'resolve'>>(contextName: ContextName, provider: RequestHandlerContextProvider<Context, ContextName>) => RequestHandlerContextContainer | Register a context provider for a route handler. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md deleted file mode 100644 index d209b526afd76..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerAuth](./kibana-plugin-core-server.httpservicesetup.registerauth.md) - -## HttpServiceSetup.registerAuth property - -To define custom authentication and/or authorization mechanism for incoming requests. - -Signature: - -```typescript -registerAuth: (handler: AuthenticationHandler) => void; -``` - -## Remarks - -A handler should return a state to associate with the incoming request. The state can be retrieved later via http.auth.get(..) Only one AuthenticationHandler can be registered. See [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md deleted file mode 100644 index 41b82f428948a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPostAuth](./kibana-plugin-core-server.httpservicesetup.registeronpostauth.md) - -## HttpServiceSetup.registerOnPostAuth property - -To define custom logic after Auth interceptor did make sure a user has access to the requested resource. - -Signature: - -```typescript -registerOnPostAuth: (handler: OnPostAuthHandler) => void; -``` - -## Remarks - -The auth state is available at stage via http.auth.get(..) Can register any number of registerOnPostAuth, which are called in sequence (from the first registered to the last). See [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md deleted file mode 100644 index 57b1833df5e03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreAuth](./kibana-plugin-core-server.httpservicesetup.registeronpreauth.md) - -## HttpServiceSetup.registerOnPreAuth property - -To define custom logic to perform for incoming requests before the Auth interceptor performs a check that user has access to requested resources. - -Signature: - -```typescript -registerOnPreAuth: (handler: OnPreAuthHandler) => void; -``` - -## Remarks - -Can register any number of registerOnPreAuth, which are called in sequence (from the first registered to the last). See [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md deleted file mode 100644 index 118bc06cc726c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreResponse](./kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md) - -## HttpServiceSetup.registerOnPreResponse property - -To define custom logic to perform for the server response. - -Signature: - -```typescript -registerOnPreResponse: (handler: OnPreResponseHandler) => void; -``` - -## Remarks - -Doesn't provide the whole response object. Supports extending response with custom headers. See [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md deleted file mode 100644 index bdf5f15828669..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreRouting](./kibana-plugin-core-server.httpservicesetup.registeronprerouting.md) - -## HttpServiceSetup.registerOnPreRouting property - -To define custom logic to perform for incoming requests before server performs a route lookup. - -Signature: - -```typescript -registerOnPreRouting: (handler: OnPreRoutingHandler) => void; -``` - -## Remarks - -It's the only place when you can forward a request to another URL right on the server. Can register any number of registerOnPreRouting, which are called in sequence (from the first registered to the last). See [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md deleted file mode 100644 index 23e009864dcd6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) - -## HttpServiceSetup.registerRouteHandlerContext property - -Register a context provider for a route handler. - -Signature: - -```typescript -registerRouteHandlerContext: >(contextName: ContextName, provider: RequestHandlerContextProvider) => RequestHandlerContextContainer; -``` - -## Example - - -```ts - // my-plugin.ts - interface MyRequestHandlerContext extends RequestHandlerContext { - myApp: { search(id: string): Promise }; - } - deps.http.registerRouteHandlerContext( - 'myApp', - (context, req) => { - async function search (id: string) { - return await context.elasticsearch.client.asCurrentUser.find(id); - } - return { search }; - } - ); - -// my-route-handler.ts - import type { MyRequestHandlerContext } from './my-plugin.ts'; - const router = createRouter(); - router.get({ path: '/', validate: false }, async (context, req, res) => { - const response = await context.myApp.search(...); - return res.ok(response); - }); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md deleted file mode 100644 index f7dffee2e125c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [auth](./kibana-plugin-core-server.httpservicestart.auth.md) - -## HttpServiceStart.auth property - -Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md) - -Signature: - -```typescript -auth: HttpAuth; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md deleted file mode 100644 index e8b2a0fc2cbaa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [basePath](./kibana-plugin-core-server.httpservicestart.basepath.md) - -## HttpServiceStart.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md deleted file mode 100644 index a95c8da64fdb0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [getServerInfo](./kibana-plugin-core-server.httpservicestart.getserverinfo.md) - -## HttpServiceStart.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md deleted file mode 100644 index de6c259c7f7a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) - -## HttpServiceStart interface - - -Signature: - -```typescript -export interface HttpServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [auth](./kibana-plugin-core-server.httpservicestart.auth.md) | HttpAuth | Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md) | -| [basePath](./kibana-plugin-core-server.httpservicestart.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [getServerInfo](./kibana-plugin-core-server.httpservicestart.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md deleted file mode 100644 index fa98f34c6ac5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) > [getLocale](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) - -## I18nServiceSetup.getLocale() method - -Return the locale currently in use. - -Signature: - -```typescript -getLocale(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md deleted file mode 100644 index ebdb0babc3af7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) > [getTranslationFiles](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) - -## I18nServiceSetup.getTranslationFiles() method - -Return the absolute paths to translation files currently in use. - -Signature: - -```typescript -getTranslationFiles(): string[]; -``` -Returns: - -string\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md deleted file mode 100644 index f68b7877953e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) - -## I18nServiceSetup interface - - -Signature: - -```typescript -export interface I18nServiceSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getLocale()](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) | Return the locale currently in use. | -| [getTranslationFiles()](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) | Return the absolute paths to translation files currently in use. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ibasepath.md b/docs/development/core/server/kibana-plugin-core-server.ibasepath.md deleted file mode 100644 index 7f0c551d1da28..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ibasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IBasePath](./kibana-plugin-core-server.ibasepath.md) - -## IBasePath type - -Access or manipulate the Kibana base path - -[BasePath](./kibana-plugin-core-server.basepath.md) - -Signature: - -```typescript -export declare type IBasePath = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md deleted file mode 100644 index c7adc345af5a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) - -## IClusterClient.asInternalUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user - -Signature: - -```typescript -readonly asInternalUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md deleted file mode 100644 index 301fcbfee5858..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) - -## IClusterClient.asScoped property - -Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) - -Signature: - -```typescript -asScoped: (request: ScopeableRequest) => IScopedClusterClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md deleted file mode 100644 index 969a32d96a3a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) - -## IClusterClient interface - -Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`). - -Signature: - -```typescript -export interface IClusterClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user | -| [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) | (request: ScopeableRequest) => IScopedClusterClient | Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md deleted file mode 100644 index ac13b86295f6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) > [createHandler](./kibana-plugin-core-server.icontextcontainer.createhandler.md) - -## IContextContainer.createHandler() method - -Create a new handler function pre-wired to context for the plugin. - -Signature: - -```typescript -createHandler(pluginOpaqueId: PluginOpaqueId, handler: RequestHandler): (...rest: HandlerParameters) => ShallowPromise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginOpaqueId | PluginOpaqueId | The plugin opaque ID for the plugin that registers this handler. | -| handler | RequestHandler | Handler function to pass context object to. | - -Returns: - -(...rest: HandlerParameters<RequestHandler>) => ShallowPromise<ReturnType<RequestHandler>> - -A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of the `handler` return value. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md deleted file mode 100644 index 99cddecb38d43..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md +++ /dev/null @@ -1,79 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) - -## IContextContainer interface - -An object that handles registration of context providers and configuring handlers with context. - -Signature: - -```typescript -export interface IContextContainer -``` - -## Remarks - -A [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares. - -Contexts providers are executed in the order they were registered. Each provider gets access to context values provided by any plugins that it depends on. - -In order to configure a handler with context, you must call the [IContextContainer.createHandler()](./kibana-plugin-core-server.icontextcontainer.createhandler.md) function and use the returned handler which will automatically build a context object when called. - -When registering context or creating handlers, the \_calling plugin's opaque id\_ must be provided. This id is passed in via the plugin's initializer and can be accessed from the [PluginInitializerContext.opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) Note this should NOT be the context service owner's id, but the plugin that is actually registering the context or handler. - -```ts -// Correct -class MyPlugin { - private readonly handlers = new Map(); - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(pluginOpaqueId, contextName, provider) { - this.contextContainer.registerContext(pluginOpaqueId, contextName, provider); - }, - registerRoute(pluginOpaqueId, path, handler) { - this.handlers.set( - path, - this.contextContainer.createHandler(pluginOpaqueId, handler) - ); - } - } - } -} - -// Incorrect -class MyPlugin { - private readonly handlers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(contextName, provider) { - // BUG! - // This would leak this context to all handlers rather that only plugins that depend on the calling plugin. - this.contextContainer.registerContext(this.initContext.opaqueId, contextName, provider); - }, - registerRoute(path, handler) { - this.handlers.set( - path, - // BUG! - // This handler will not receive any contexts provided by other dependencies of the calling plugin. - this.contextContainer.createHandler(this.initContext.opaqueId, handler) - ); - } - } - } -} -``` - -## Methods - -| Method | Description | -| --- | --- | -| [createHandler(pluginOpaqueId, handler)](./kibana-plugin-core-server.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. | -| [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-core-server.icontextcontainer.registercontext.md) | Register a new context provider. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md deleted file mode 100644 index 32b177df2b2ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) > [registerContext](./kibana-plugin-core-server.icontextcontainer.registercontext.md) - -## IContextContainer.registerContext() method - -Register a new context provider. - -Signature: - -```typescript -registerContext(pluginOpaqueId: PluginOpaqueId, contextName: ContextName, provider: IContextProvider): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginOpaqueId | PluginOpaqueId | The plugin opaque ID for the plugin that registers this context. | -| contextName | ContextName | The key of the TContext object this provider supplies the value for. | -| provider | IContextProvider<Context, ContextName> | A [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) to be called each time a new context is created. | - -Returns: - -this - -The [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for method chaining. - -## Remarks - -The value (or resolved Promise value) returned by the `provider` function will be attached to the context object on the key specified by `contextName`. - -Throws an exception if more than one provider is registered for the same `contextName`. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md b/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md deleted file mode 100644 index eb2ec3cbf90b8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) - -## IContextProvider type - -A function that returns a context value for a specific key of given context type. - -Signature: - -```typescript -export declare type IContextProvider = (context: Omit, ...rest: HandlerParameters) => MaybePromise>; -``` - -## Remarks - -This function will be called each time a new context is built for a handler invocation. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md deleted file mode 100644 index 42b177c348afe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) - -## ICspConfig.disableEmbedding property - -Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. - -Signature: - -```typescript -readonly disableEmbedding: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md deleted file mode 100644 index 779a0184e9fb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [header](./kibana-plugin-core-server.icspconfig.header.md) - -## ICspConfig.header property - -The CSP rules in a formatted directives string for use in a `Content-Security-Policy` header. - -Signature: - -```typescript -readonly header: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.md deleted file mode 100644 index d5667900a41e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) - -## ICspConfig interface - -CSP configuration for use in Kibana. - -Signature: - -```typescript -export interface ICspConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) | boolean | Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. | -| [header](./kibana-plugin-core-server.icspconfig.header.md) | string | The CSP rules in a formatted directives string for use in a Content-Security-Policy header. | -| [strict](./kibana-plugin-core-server.icspconfig.strict.md) | boolean | Specify whether browsers that do not support CSP should be able to use Kibana. Use true to block and false to allow. | -| [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) | boolean | Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md deleted file mode 100644 index d8ea8ec377831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [strict](./kibana-plugin-core-server.icspconfig.strict.md) - -## ICspConfig.strict property - -Specify whether browsers that do not support CSP should be able to use Kibana. Use `true` to block and `false` to allow. - -Signature: - -```typescript -readonly strict: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md deleted file mode 100644 index 84286262bcbf2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) - -## ICspConfig.warnLegacyBrowsers property - -Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. - -Signature: - -```typescript -readonly warnLegacyBrowsers: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md deleted file mode 100644 index 5fa2e93cca75b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) > [close](./kibana-plugin-core-server.icustomclusterclient.close.md) - -## ICustomClusterClient.close property - -Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. - -Signature: - -```typescript -close: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md deleted file mode 100644 index 1c65137d1ddc1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) - -## ICustomClusterClient interface - -See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) - -Signature: - -```typescript -export interface ICustomClusterClient extends IClusterClient -``` -Extends: IClusterClient - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [close](./kibana-plugin-core-server.icustomclusterclient.close.md) | () => Promise<void> | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md deleted file mode 100644 index 2ab3f52b9b553..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) - -## IExecutionContextContainer interface - - -Signature: - -```typescript -export interface IExecutionContextContainer -``` - -## Methods - -| Method | Description | -| --- | --- | -| [toJSON()](./kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md) | | -| [toString()](./kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md) | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md deleted file mode 100644 index a561e6c319408..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) > [toJSON](./kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md) - -## IExecutionContextContainer.toJSON() method - -Signature: - -```typescript -toJSON(): Readonly; -``` -Returns: - -Readonly<KibanaExecutionContext> - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md deleted file mode 100644 index 666da5bef3969..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) > [toString](./kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md) - -## IExecutionContextContainer.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md deleted file mode 100644 index b5490a9548dc1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) - -## IExternalUrlConfig interface - -External Url configuration for use in Kibana. - -Signature: - -```typescript -export interface IExternalUrlConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) | IExternalUrlPolicy\[\] | A set of policies describing which external urls are allowed. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md deleted file mode 100644 index b5b6f07038076..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) > [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) - -## IExternalUrlConfig.policy property - -A set of policies describing which external urls are allowed. - -Signature: - -```typescript -readonly policy: IExternalUrlPolicy[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md deleted file mode 100644 index 47d3dbf83f2b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) - -## IExternalUrlPolicy.allow property - -Indicates if this policy allows or denies access to the described destination. - -Signature: - -```typescript -allow: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md deleted file mode 100644 index a549f80509474..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [host](./kibana-plugin-core-server.iexternalurlpolicy.host.md) - -## IExternalUrlPolicy.host property - -Optional host describing the external destination. May be combined with `protocol`. - -Signature: - -```typescript -host?: string; -``` - -## Example - - -```ts -// allows access to all of google.com, using any protocol. -allow: true, -host: 'google.com' -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md deleted file mode 100644 index 45f7798eaf336..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) - -## IExternalUrlPolicy interface - -A policy describing whether access to an external destination is allowed. - -Signature: - -```typescript -export interface IExternalUrlPolicy -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. | -| [host?](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined with protocol. | -| [protocol?](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md deleted file mode 100644 index 86f6e6164de4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) - -## IExternalUrlPolicy.protocol property - -Optional protocol describing the external destination. May be combined with `host`. - -Signature: - -```typescript -protocol?: string; -``` - -## Example - - -```ts -// allows access to all destinations over the `https` protocol. -allow: true, -protocol: 'https' -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md deleted file mode 100644 index c71f5360834e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) - -## IKibanaResponse interface - -A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution - -Signature: - -```typescript -export interface IKibanaResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [options](./kibana-plugin-core-server.ikibanaresponse.options.md) | HttpResponseOptions | | -| [payload?](./kibana-plugin-core-server.ikibanaresponse.payload.md) | T | (Optional) | -| [status](./kibana-plugin-core-server.ikibanaresponse.status.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md deleted file mode 100644 index a91224a11282d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [options](./kibana-plugin-core-server.ikibanaresponse.options.md) - -## IKibanaResponse.options property - -Signature: - -```typescript -readonly options: HttpResponseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md deleted file mode 100644 index 2475402bfb9fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [payload](./kibana-plugin-core-server.ikibanaresponse.payload.md) - -## IKibanaResponse.payload property - -Signature: - -```typescript -readonly payload?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md deleted file mode 100644 index 2d7494d0e22b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [status](./kibana-plugin-core-server.ikibanaresponse.status.md) - -## IKibanaResponse.status property - -Signature: - -```typescript -readonly status: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md deleted file mode 100644 index 930179acf399a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [authorizationError](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) - -## IKibanaSocket.authorizationError property - -The reason why the peer's certificate has not been verified. This property becomes available only when `authorized` is `false`. - -Signature: - -```typescript -readonly authorizationError?: Error; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md deleted file mode 100644 index 5ead5a8556c92..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [authorized](./kibana-plugin-core-server.ikibanasocket.authorized.md) - -## IKibanaSocket.authorized property - -Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is `undefined`. - -Signature: - -```typescript -readonly authorized?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md deleted file mode 100644 index 9f0dce061bcfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate.md) - -## IKibanaSocket.getPeerCertificate() method - -Signature: - -```typescript -getPeerCertificate(detailed: true): DetailedPeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | true | | - -Returns: - -DetailedPeerCertificate \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md deleted file mode 100644 index 363fce50251d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md) - -## IKibanaSocket.getPeerCertificate() method - -Signature: - -```typescript -getPeerCertificate(detailed: false): PeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | false | | - -Returns: - -PeerCertificate \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md deleted file mode 100644 index 24b11b6966000..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md) - -## IKibanaSocket.getPeerCertificate() method - -Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. - -Signature: - -```typescript -getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | boolean | If true; the full chain with issuer property will be returned. | - -Returns: - -PeerCertificate \| DetailedPeerCertificate \| null - -An object representing the peer's certificate. - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md deleted file mode 100644 index d605f2fd21bef..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getProtocol](./kibana-plugin-core-server.ikibanasocket.getprotocol.md) - -## IKibanaSocket.getProtocol() method - -Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL\_get\_version.html for more information. - -Signature: - -```typescript -getProtocol(): string | null; -``` -Returns: - -string \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md deleted file mode 100644 index bc8f59df9d211..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) - -## IKibanaSocket interface - -A tiny abstraction for TCP socket. - -Signature: - -```typescript -export interface IKibanaSocket -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authorizationError?](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) | Error | (Optional) The reason why the peer's certificate has not been verified. This property becomes available only when authorized is false. | -| [authorized?](./kibana-plugin-core-server.ikibanasocket.authorized.md) | boolean | (Optional) Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is undefined. | - -## Methods - -| Method | Description | -| --- | --- | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate.md) | | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md) | | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md) | Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. | -| [getProtocol()](./kibana-plugin-core-server.ikibanasocket.getprotocol.md) | Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL\_get\_version.html for more information. | -| [renegotiate(options)](./kibana-plugin-core-server.ikibanasocket.renegotiate.md) | Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md deleted file mode 100644 index b4addde9b3179..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [renegotiate](./kibana-plugin-core-server.ikibanasocket.renegotiate.md) - -## IKibanaSocket.renegotiate() method - -Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. - -Signature: - -```typescript -renegotiate(options: { - rejectUnauthorized?: boolean; - requestCert?: boolean; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | { rejectUnauthorized?: boolean; requestCert?: boolean; } | The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). | - -Returns: - -Promise<void> - -A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed. - diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md deleted file mode 100644 index 664bdb8f24d7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) - -## IntervalHistogram.exceeds property - -Signature: - -```typescript -exceeds: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md deleted file mode 100644 index 00fa8dcb84430..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) - -## IntervalHistogram.fromTimestamp property - -Signature: - -```typescript -fromTimestamp: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md deleted file mode 100644 index 58e75fc2ba437..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) - -## IntervalHistogram.lastUpdatedAt property - -Signature: - -```typescript -lastUpdatedAt: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md deleted file mode 100644 index 14d7fe6b68c4b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [max](./kibana-plugin-core-server.intervalhistogram.max.md) - -## IntervalHistogram.max property - -Signature: - -```typescript -max: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md deleted file mode 100644 index 56a87a1577e98..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) - -## IntervalHistogram interface - -an IntervalHistogram object that samples and reports the event loop delay over time. The delays will be reported in milliseconds. - -Signature: - -```typescript -export interface IntervalHistogram -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) | number | | -| [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) | string | | -| [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) | string | | -| [max](./kibana-plugin-core-server.intervalhistogram.max.md) | number | | -| [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) | number | | -| [min](./kibana-plugin-core-server.intervalhistogram.min.md) | number | | -| [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) | { 50: number; 75: number; 95: number; 99: number; } | | -| [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md deleted file mode 100644 index e6794bfa5fe52..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) - -## IntervalHistogram.mean property - -Signature: - -```typescript -mean: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md deleted file mode 100644 index d0eb929601f18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [min](./kibana-plugin-core-server.intervalhistogram.min.md) - -## IntervalHistogram.min property - -Signature: - -```typescript -min: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md deleted file mode 100644 index b0adc9531c0b1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) - -## IntervalHistogram.percentiles property - -Signature: - -```typescript -percentiles: { - 50: number; - 75: number; - 95: number; - 99: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md deleted file mode 100644 index bca5ab56cb237..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) - -## IntervalHistogram.stddev property - -Signature: - -```typescript -stddev: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md deleted file mode 100644 index dc2af11f9f9d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) > [isAnonymousPage](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) - -## IRenderOptions.isAnonymousPage property - -Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. `false` by default. - -Signature: - -```typescript -isAnonymousPage?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md deleted file mode 100644 index 84539a6aa73ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) - -## IRenderOptions interface - - -Signature: - -```typescript -export interface IRenderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isAnonymousPage?](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) | boolean | (Optional) Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. false by default. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md b/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md deleted file mode 100644 index a7b6dd5bc294e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [delete](./kibana-plugin-core-server.irouter.delete.md) - -## IRouter.delete property - -Register a route handler for `DELETE` request. - -Signature: - -```typescript -delete: RouteRegistrar<'delete', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md b/docs/development/core/server/kibana-plugin-core-server.irouter.get.md deleted file mode 100644 index 7db694b38da47..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [get](./kibana-plugin-core-server.irouter.get.md) - -## IRouter.get property - -Register a route handler for `GET` request. - -Signature: - -```typescript -get: RouteRegistrar<'get', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md deleted file mode 100644 index 35d109975c83a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) - -## IRouter.handleLegacyErrors property - -Wrap a router handler to catch and converts legacy boom errors to proper custom errors. - -Signature: - -```typescript -handleLegacyErrors: RequestHandlerWrapper; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.md b/docs/development/core/server/kibana-plugin-core-server.irouter.md deleted file mode 100644 index a751ea399c5a9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) - -## IRouter interface - -Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations. - -Signature: - -```typescript -export interface IRouter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [delete](./kibana-plugin-core-server.irouter.delete.md) | RouteRegistrar<'delete', Context> | Register a route handler for DELETE request. | -| [get](./kibana-plugin-core-server.irouter.get.md) | RouteRegistrar<'get', Context> | Register a route handler for GET request. | -| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | RequestHandlerWrapper | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. | -| [patch](./kibana-plugin-core-server.irouter.patch.md) | RouteRegistrar<'patch', Context> | Register a route handler for PATCH request. | -| [post](./kibana-plugin-core-server.irouter.post.md) | RouteRegistrar<'post', Context> | Register a route handler for POST request. | -| [put](./kibana-plugin-core-server.irouter.put.md) | RouteRegistrar<'put', Context> | Register a route handler for PUT request. | -| [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) | string | Resulted path | - diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md b/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md deleted file mode 100644 index b353079630ecb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [patch](./kibana-plugin-core-server.irouter.patch.md) - -## IRouter.patch property - -Register a route handler for `PATCH` request. - -Signature: - -```typescript -patch: RouteRegistrar<'patch', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md b/docs/development/core/server/kibana-plugin-core-server.irouter.post.md deleted file mode 100644 index 94c703ad6f339..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [post](./kibana-plugin-core-server.irouter.post.md) - -## IRouter.post property - -Register a route handler for `POST` request. - -Signature: - -```typescript -post: RouteRegistrar<'post', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md b/docs/development/core/server/kibana-plugin-core-server.irouter.put.md deleted file mode 100644 index 702ff3ff61bb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [put](./kibana-plugin-core-server.irouter.put.md) - -## IRouter.put property - -Register a route handler for `PUT` request. - -Signature: - -```typescript -put: RouteRegistrar<'put', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md b/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md deleted file mode 100644 index c326e33b01f1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) - -## IRouter.routerPath property - -Resulted path - -Signature: - -```typescript -routerPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md b/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md deleted file mode 100644 index 0c2d7fab8b579..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) - -## IsAuthenticated type - -Returns authentication status for a request. - -Signature: - -```typescript -export declare type IsAuthenticated = (request: KibanaRequest) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md deleted file mode 100644 index 826583a85ed8a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) > [exportByObjects](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) - -## ISavedObjectsExporter.exportByObjects() method - -Generates an export stream for given object references. - -See the [options](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) for more detailed information. - -Signature: - -```typescript -exportByObjects(options: SavedObjectsExportByObjectOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsExportByObjectOptions | | - -Returns: - -Promise<Readable> - -## Exceptions - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md deleted file mode 100644 index b1f354e7914f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) > [exportByTypes](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) - -## ISavedObjectsExporter.exportByTypes() method - -Generates an export stream for given types. - -See the [options](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) for more detailed information. - -Signature: - -```typescript -exportByTypes(options: SavedObjectsExportByTypeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsExportByTypeOptions | | - -Returns: - -Promise<Readable> - -## Exceptions - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md deleted file mode 100644 index 4e9643ef8261d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) - -## ISavedObjectsExporter interface - -Utility class used to export savedObjects. - -Signature: - -```typescript -export interface ISavedObjectsExporter -``` - -## Methods - -| Method | Description | -| --- | --- | -| [exportByObjects(options)](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) | Generates an export stream for given object references.See the [options](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) for more detailed information. | -| [exportByTypes(options)](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) | Generates an export stream for given types.See the [options](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) for more detailed information. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md deleted file mode 100644 index 0622bb511eb8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) > [import](./kibana-plugin-core-server.isavedobjectsimporter.import.md) - -## ISavedObjectsImporter.import() method - -Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. - -Signature: - -```typescript -import(options: SavedObjectsImportOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsImportOptions | | - -Returns: - -Promise<SavedObjectsImportResponse> - -## Exceptions - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md deleted file mode 100644 index 93e0d5092ebf9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) - -## ISavedObjectsImporter interface - -Utility class used to import savedObjects. - -Signature: - -```typescript -export interface ISavedObjectsImporter -``` - -## Methods - -| Method | Description | -| --- | --- | -| [import(options)](./kibana-plugin-core-server.isavedobjectsimporter.import.md) | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. | -| [resolveImportErrors(options)](./kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md) | Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md deleted file mode 100644 index 9d25439e61c81..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) > [resolveImportErrors](./kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md) - -## ISavedObjectsImporter.resolveImportErrors() method - -Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. - -Signature: - -```typescript -resolveImportErrors(options: SavedObjectsResolveImportErrorsOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsResolveImportErrorsOptions | | - -Returns: - -Promise<SavedObjectsImportResponse> - -## Exceptions - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md deleted file mode 100644 index f7cfab446eeca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) > [close](./kibana-plugin-core-server.isavedobjectspointintimefinder.close.md) - -## ISavedObjectsPointInTimeFinder.close property - -Closes the Point-In-Time associated with this finder instance. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -close: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md deleted file mode 100644 index 29d4668becffc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) > [find](./kibana-plugin-core-server.isavedobjectspointintimefinder.find.md) - -## ISavedObjectsPointInTimeFinder.find property - -An async generator which wraps calls to `savedObjectsClient.find` and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage` size. - -Signature: - -```typescript -find: () => AsyncGenerator>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md deleted file mode 100644 index 748ffbdc3c4e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) - -## ISavedObjectsPointInTimeFinder interface - - -Signature: - -```typescript -export interface ISavedObjectsPointInTimeFinder -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [close](./kibana-plugin-core-server.isavedobjectspointintimefinder.close.md) | () => Promise<void> | Closes the Point-In-Time associated with this finder instance.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [find](./kibana-plugin-core-server.isavedobjectspointintimefinder.find.md) | () => AsyncGenerator<SavedObjectsFindResponse<T, A>> | An async generator which wraps calls to savedObjectsClient.find and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage size. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md deleted file mode 100644 index 90cd2d605da8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsRepository](./kibana-plugin-core-server.isavedobjectsrepository.md) - -## ISavedObjectsRepository type - -See [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) - -Signature: - -```typescript -export declare type ISavedObjectsRepository = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md deleted file mode 100644 index f9c621885c001..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectTypeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - -## ISavedObjectTypeRegistry type - -See [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) for documentation. - -Signature: - -```typescript -export declare type ISavedObjectTypeRegistry = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md deleted file mode 100644 index ddc6357bb8835..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) - -## IScopedClusterClient.asCurrentUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. - -Signature: - -```typescript -readonly asCurrentUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md deleted file mode 100644 index f7f308aa13161..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) - -## IScopedClusterClient.asInternalUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. - -Signature: - -```typescript -readonly asInternalUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md deleted file mode 100644 index f0d75f2f08fe4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) - -## IScopedClusterClient interface - -Serves the same purpose as the normal [cluster client](./kibana-plugin-core-server.iclusterclient.md) but exposes an additional `asCurrentUser` method that doesn't use credentials of the Kibana internal user (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API instead. - -Signature: - -```typescript -export interface IScopedClusterClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. | -| [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md deleted file mode 100644 index 36252e37d2f5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [get](./kibana-plugin-core-server.iuisettingsclient.get.md) - -## IUiSettingsClient.get property - -Retrieves uiSettings values set by the user with fallbacks to default values if not specified. - -Signature: - -```typescript -get: (key: string) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md deleted file mode 100644 index d1cc06dd83484..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getAll](./kibana-plugin-core-server.iuisettingsclient.getall.md) - -## IUiSettingsClient.getAll property - -Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. - -Signature: - -```typescript -getAll: () => Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md deleted file mode 100644 index 71a2bbf88472e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getRegistered](./kibana-plugin-core-server.iuisettingsclient.getregistered.md) - -## IUiSettingsClient.getRegistered property - -Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) - -Signature: - -```typescript -getRegistered: () => Readonly>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md deleted file mode 100644 index 93d5f33709379..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getUserProvided](./kibana-plugin-core-server.iuisettingsclient.getuserprovided.md) - -## IUiSettingsClient.getUserProvided property - -Retrieves a set of all uiSettings values set by the user. - -Signature: - -```typescript -getUserProvided: () => Promise>>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md deleted file mode 100644 index c9af118895f13..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [isOverridden](./kibana-plugin-core-server.iuisettingsclient.isoverridden.md) - -## IUiSettingsClient.isOverridden property - -Shows whether the uiSettings value set by the user. - -Signature: - -```typescript -isOverridden: (key: string) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md deleted file mode 100644 index a6f263e0b0f55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [isSensitive](./kibana-plugin-core-server.iuisettingsclient.issensitive.md) - -## IUiSettingsClient.isSensitive property - -Shows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values. - -Signature: - -```typescript -isSensitive: (key: string) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md deleted file mode 100644 index ad7819719e14a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) - -## IUiSettingsClient interface - -Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. - -Signature: - -```typescript -export interface IUiSettingsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-server.iuisettingsclient.get.md) | <T = any>(key: string) => Promise<T> | Retrieves uiSettings values set by the user with fallbacks to default values if not specified. | -| [getAll](./kibana-plugin-core-server.iuisettingsclient.getall.md) | <T = any>() => Promise<Record<string, T>> | Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. | -| [getRegistered](./kibana-plugin-core-server.iuisettingsclient.getregistered.md) | () => Readonly<Record<string, PublicUiSettingsParams>> | Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) | -| [getUserProvided](./kibana-plugin-core-server.iuisettingsclient.getuserprovided.md) | <T = any>() => Promise<Record<string, UserProvidedValues<T>>> | Retrieves a set of all uiSettings values set by the user. | -| [isOverridden](./kibana-plugin-core-server.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. | -| [isSensitive](./kibana-plugin-core-server.iuisettingsclient.issensitive.md) | (key: string) => boolean | Shows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values. | -| [remove](./kibana-plugin-core-server.iuisettingsclient.remove.md) | (key: string) => Promise<void> | Removes uiSettings value by key. | -| [removeMany](./kibana-plugin-core-server.iuisettingsclient.removemany.md) | (keys: string\[\]) => Promise<void> | Removes multiple uiSettings values by keys. | -| [set](./kibana-plugin-core-server.iuisettingsclient.set.md) | (key: string, value: any) => Promise<void> | Writes uiSettings value and marks it as set by the user. | -| [setMany](./kibana-plugin-core-server.iuisettingsclient.setmany.md) | (changes: Record<string, any>) => Promise<void> | Writes multiple uiSettings values and marks them as set by the user. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md deleted file mode 100644 index 3496e30470eab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [remove](./kibana-plugin-core-server.iuisettingsclient.remove.md) - -## IUiSettingsClient.remove property - -Removes uiSettings value by key. - -Signature: - -```typescript -remove: (key: string) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md deleted file mode 100644 index 8b76ea5cdec07..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [removeMany](./kibana-plugin-core-server.iuisettingsclient.removemany.md) - -## IUiSettingsClient.removeMany property - -Removes multiple uiSettings values by keys. - -Signature: - -```typescript -removeMany: (keys: string[]) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md deleted file mode 100644 index c5254d1df8040..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [set](./kibana-plugin-core-server.iuisettingsclient.set.md) - -## IUiSettingsClient.set property - -Writes uiSettings value and marks it as set by the user. - -Signature: - -```typescript -set: (key: string, value: any) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md deleted file mode 100644 index cb03889c7f4bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [setMany](./kibana-plugin-core-server.iuisettingsclient.setmany.md) - -## IUiSettingsClient.setMany property - -Writes multiple uiSettings values and marks them as set by the user. - -Signature: - -```typescript -setMany: (changes: Record) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md b/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md deleted file mode 100644 index 792af8f693869..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaExecutionContext](./kibana-plugin-core-server.kibanaexecutioncontext.md) - -## KibanaExecutionContext type - -Represents a meta-information about a Kibana entity initiating a search request. - -Signature: - -```typescript -export declare type KibanaExecutionContext = { - readonly type?: string; - readonly name?: string; - readonly page?: string; - readonly id?: string; - readonly description?: string; - readonly url?: string; - child?: KibanaExecutionContext; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md deleted file mode 100644 index 682d6c87629fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [(constructor)](./kibana-plugin-core-server.kibanarequest._constructor_.md) - -## KibanaRequest.(constructor) - -Constructs a new instance of the `KibanaRequest` class - -Signature: - -```typescript -constructor(request: Request, params: Params, query: Query, body: Body, withoutSecretHeaders: boolean); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | -| params | Params | | -| query | Query | | -| body | Body | | -| withoutSecretHeaders | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md deleted file mode 100644 index 7049c06dfa06c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [auth](./kibana-plugin-core-server.kibanarequest.auth.md) - -## KibanaRequest.auth property - -Signature: - -```typescript -readonly auth: { - isAuthenticated: boolean; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md deleted file mode 100644 index 968395af9a3f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [body](./kibana-plugin-core-server.kibanarequest.body.md) - -## KibanaRequest.body property - -Signature: - -```typescript -readonly body: Body; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md deleted file mode 100644 index 5662348242384..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [events](./kibana-plugin-core-server.kibanarequest.events.md) - -## KibanaRequest.events property - -Request events [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) - -Signature: - -```typescript -readonly events: KibanaRequestEvents; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md deleted file mode 100644 index 3dfb9b49e83ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [headers](./kibana-plugin-core-server.kibanarequest.headers.md) - -## KibanaRequest.headers property - -Readonly copy of incoming request headers. - -Signature: - -```typescript -readonly headers: Headers; -``` - -## Remarks - -This property will contain a `filtered` copy of request headers. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md deleted file mode 100644 index 8cad5972cc164..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [id](./kibana-plugin-core-server.kibanarequest.id.md) - -## KibanaRequest.id property - -A identifier to identify this request. - -Signature: - -```typescript -readonly id: string; -``` - -## Remarks - -Depending on the user's configuration, this value may be sourced from the incoming request's `X-Opaque-Id` header which is not guaranteed to be unique per request. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md deleted file mode 100644 index e5ac6e23b2116..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [isSystemRequest](./kibana-plugin-core-server.kibanarequest.issystemrequest.md) - -## KibanaRequest.isSystemRequest property - -Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the `HttpFetchOptions#asSystemRequest` option. - -Signature: - -```typescript -readonly isSystemRequest: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md deleted file mode 100644 index f4e2dda2d5499..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) - -## KibanaRequest class - -Kibana specific abstraction for an incoming request. - -Signature: - -```typescript -export declare class KibanaRequest -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(request, params, query, body, withoutSecretHeaders)](./kibana-plugin-core-server.kibanarequest._constructor_.md) | | Constructs a new instance of the KibanaRequest class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [auth](./kibana-plugin-core-server.kibanarequest.auth.md) | | { isAuthenticated: boolean; } | | -| [body](./kibana-plugin-core-server.kibanarequest.body.md) | | Body | | -| [events](./kibana-plugin-core-server.kibanarequest.events.md) | | KibanaRequestEvents | Request events [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | -| [headers](./kibana-plugin-core-server.kibanarequest.headers.md) | | Headers | Readonly copy of incoming request headers. | -| [id](./kibana-plugin-core-server.kibanarequest.id.md) | | string | A identifier to identify this request. | -| [isSystemRequest](./kibana-plugin-core-server.kibanarequest.issystemrequest.md) | | boolean | Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the HttpFetchOptions#asSystemRequest option. | -| [params](./kibana-plugin-core-server.kibanarequest.params.md) | | Params | | -| [query](./kibana-plugin-core-server.kibanarequest.query.md) | | Query | | -| [rewrittenUrl?](./kibana-plugin-core-server.kibanarequest.rewrittenurl.md) | | URL | (Optional) URL rewritten in onPreRouting request interceptor. | -| [route](./kibana-plugin-core-server.kibanarequest.route.md) | | RecursiveReadonly<KibanaRequestRoute<Method>> | matched route details | -| [socket](./kibana-plugin-core-server.kibanarequest.socket.md) | | IKibanaSocket | [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) | -| [url](./kibana-plugin-core-server.kibanarequest.url.md) | | URL | a WHATWG URL standard object. | -| [uuid](./kibana-plugin-core-server.kibanarequest.uuid.md) | | string | A UUID to identify this request. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md deleted file mode 100644 index ff2e4ac2f11eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [params](./kibana-plugin-core-server.kibanarequest.params.md) - -## KibanaRequest.params property - -Signature: - -```typescript -readonly params: Params; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md deleted file mode 100644 index b111aa3d66137..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [query](./kibana-plugin-core-server.kibanarequest.query.md) - -## KibanaRequest.query property - -Signature: - -```typescript -readonly query: Query; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md deleted file mode 100644 index fb547330ee6ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [rewrittenUrl](./kibana-plugin-core-server.kibanarequest.rewrittenurl.md) - -## KibanaRequest.rewrittenUrl property - -URL rewritten in onPreRouting request interceptor. - -Signature: - -```typescript -readonly rewrittenUrl?: URL; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md deleted file mode 100644 index b98844775abcc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [route](./kibana-plugin-core-server.kibanarequest.route.md) - -## KibanaRequest.route property - -matched route details - -Signature: - -```typescript -readonly route: RecursiveReadonly>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md deleted file mode 100644 index 2e18cc336d222..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [socket](./kibana-plugin-core-server.kibanarequest.socket.md) - -## KibanaRequest.socket property - -[IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) - -Signature: - -```typescript -readonly socket: IKibanaSocket; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md deleted file mode 100644 index b72760e272bb2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [url](./kibana-plugin-core-server.kibanarequest.url.md) - -## KibanaRequest.url property - -a WHATWG URL standard object. - -Signature: - -```typescript -readonly url: URL; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md deleted file mode 100644 index 8b980b82d0adb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [uuid](./kibana-plugin-core-server.kibanarequest.uuid.md) - -## KibanaRequest.uuid property - -A UUID to identify this request. - -Signature: - -```typescript -readonly uuid: string; -``` - -## Remarks - -This value is NOT sourced from the incoming request's `X-Opaque-Id` header. it is always a UUID uniquely identifying the request. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md deleted file mode 100644 index ea16a0529f9f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) > [aborted$](./kibana-plugin-core-server.kibanarequestevents.aborted_.md) - -## KibanaRequestEvents.aborted$ property - -Observable that emits once if and when the request has been aborted. - -Signature: - -```typescript -aborted$: Observable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md deleted file mode 100644 index c9f8ab11f6b12..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) > [completed$](./kibana-plugin-core-server.kibanarequestevents.completed_.md) - -## KibanaRequestEvents.completed$ property - -Observable that emits once if and when the request has been completely handled. - -Signature: - -```typescript -completed$: Observable; -``` - -## Remarks - -The request may be considered completed if: - A response has been sent to the client; or - The request was aborted. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md deleted file mode 100644 index c61e4aeec7c85..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) - -## KibanaRequestEvents interface - -Request events. - -Signature: - -```typescript -export interface KibanaRequestEvents -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aborted$](./kibana-plugin-core-server.kibanarequestevents.aborted_.md) | Observable<void> | Observable that emits once if and when the request has been aborted. | -| [completed$](./kibana-plugin-core-server.kibanarequestevents.completed_.md) | Observable<void> | Observable that emits once if and when the request has been completely handled. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md deleted file mode 100644 index 196c352e21f8a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) - -## KibanaRequestRoute interface - -Request specific route information exposed to a handler. - -Signature: - -```typescript -export interface KibanaRequestRoute -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [method](./kibana-plugin-core-server.kibanarequestroute.method.md) | Method | | -| [options](./kibana-plugin-core-server.kibanarequestroute.options.md) | KibanaRequestRouteOptions<Method> | | -| [path](./kibana-plugin-core-server.kibanarequestroute.path.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md deleted file mode 100644 index a1549df34d1b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [method](./kibana-plugin-core-server.kibanarequestroute.method.md) - -## KibanaRequestRoute.method property - -Signature: - -```typescript -method: Method; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md deleted file mode 100644 index 4d2b4253c69a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [options](./kibana-plugin-core-server.kibanarequestroute.options.md) - -## KibanaRequestRoute.options property - -Signature: - -```typescript -options: KibanaRequestRouteOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md deleted file mode 100644 index 32357ba4534a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [path](./kibana-plugin-core-server.kibanarequestroute.path.md) - -## KibanaRequestRoute.path property - -Signature: - -```typescript -path: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md deleted file mode 100644 index f3d77d930cd9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRouteOptions](./kibana-plugin-core-server.kibanarequestrouteoptions.md) - -## KibanaRequestRouteOptions type - -Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. - -Signature: - -```typescript -export declare type KibanaRequestRouteOptions = Method extends 'get' | 'options' ? Required, 'body'>> : Required>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md b/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md deleted file mode 100644 index e02f208ae86ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md +++ /dev/null @@ -1,130 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [kibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) - -## kibanaResponseFactory variable - -Set of helpers used to create `KibanaResponse` to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution. - -Signature: - -```typescript -kibanaResponseFactory: { - custom: | Buffer | Error | { - message: string | Error; - attributes?: ResponseErrorAttributes | undefined; - } | Stream | undefined>(options: CustomHttpResponseOptions) => KibanaResponse; - badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; - unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; - forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; - notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; - conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; - customError: (options: CustomHttpResponseOptions) => KibanaResponse; - redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; - ok: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; - accepted: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; - noContent: (options?: HttpResponseOptions) => KibanaResponse; -} -``` - -## Example - -1. Successful response. Supported types of response body are: - `undefined`, no content to send. - `string`, send text - `JSON`, send JSON object, HTTP server will throw if given object is not valid (has circular references, for example) - `Stream` send data stream - `Buffer` send binary stream - -```js -return response.ok(); -return response.ok({ body: 'ack' }); -return response.ok({ body: { id: '1' } }); -return response.ok({ body: Buffer.from(...) }); - -const stream = new Stream.PassThrough(); -fs.createReadStream('./file').pipe(stream); -return res.ok({ body: stream }); -``` -HTTP headers are configurable via response factory parameter `options` [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md). - -```js -return response.ok({ - body: { id: '1' }, - headers: { - 'content-type': 'application/json' - } -}); -``` -2. Redirection response. Redirection URL is configures via 'Location' header. - -```js -return response.redirected({ - body: 'The document has moved', - headers: { - location: '/new-url', - }, -}); -``` -3. Error response. You may pass an error message to the client, where error message can be: - `string` send message text - `Error` send the message text of given Error object. - `{ message: string | Error, attributes: {data: Record, ...} }` - send message text and attach additional error data. - -```js -return response.unauthorized({ - body: 'User has no access to the requested resource.', - headers: { - 'WWW-Authenticate': 'challenge', - } -}) -return response.badRequest(); -return response.badRequest({ body: 'validation error' }); - -try { - // ... -} catch(error){ - return response.badRequest({ body: error }); -} - -return response.badRequest({ - body:{ - message: 'validation error', - attributes: { - requestBody: request.body, - failedFields: validationResult - } - } -}); - -try { - // ... -} catch(error) { - return response.badRequest({ - body: error - }); -} - -``` -4. Custom response. `ResponseFactory` may not cover your use case, so you can use the `custom` function to customize the response. - -```js -return response.custom({ - body: 'ok', - statusCode: 201, - headers: { - location: '/created-url' - } -}) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.knownheaders.md b/docs/development/core/server/kibana-plugin-core-server.knownheaders.md deleted file mode 100644 index cc7ca472e5777..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.knownheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KnownHeaders](./kibana-plugin-core-server.knownheaders.md) - -## KnownHeaders type - -Set of well-known HTTP headers. - -Signature: - -```typescript -export declare type KnownHeaders = KnownKeys; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md b/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md deleted file mode 100644 index c78b998aef9e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [LifecycleResponseFactory](./kibana-plugin-core-server.lifecycleresponsefactory.md) - -## LifecycleResponseFactory type - -Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. - -Signature: - -```typescript -export declare type LifecycleResponseFactory = typeof lifecycleResponseFactory; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md b/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md deleted file mode 100644 index f47d01a2d09e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) - -## MakeUsageFromSchema type - -List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to `true` then the actual value of these configs will be reoprted. If parent node or actual config path is set to `false` then the config will be reported as \[redacted\]. - -Signature: - -```typescript -export declare type MakeUsageFromSchema = { - [Key in keyof T]?: T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? MakeUsageFromSchema | boolean : boolean; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md deleted file mode 100644 index 77d61ff7f373b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.md +++ /dev/null @@ -1,338 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) - -## kibana-plugin-core-server package - -The Kibana Core APIs for server-side plugins. - -A plugin requires a `kibana.json` file at it's root directory that follows [the manfiest schema](./kibana-plugin-core-server.pluginmanifest.md) to define static plugin information required to load the plugin. - -A plugin's `server/index` file must contain a named import, `plugin`, that implements [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) which returns an object that implements . - -The plugin integrates with the core system via lifecycle events: `setup`, `start`, and `stop`. In each lifecycle method, the plugin will receive the corresponding core services available (either [CoreSetup](./kibana-plugin-core-server.coresetup.md) or [CoreStart](./kibana-plugin-core-server.corestart.md)) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. - -## Classes - -| Class | Description | -| --- | --- | -| [BasePath](./kibana-plugin-core-server.basepath.md) | Access or manipulate the Kibana base path | -| [CspConfig](./kibana-plugin-core-server.cspconfig.md) | CSP configuration for use in Kibana. | -| [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) | Wrapper of config schema. | -| [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) | | -| [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) | Kibana specific abstraction for an incoming request. | -| [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) | Error to return when the validation is not successful. | -| [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) | | -| [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | | -| [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) | | -| [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) | | -| [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | | -| [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) | A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. | -| [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) | | -| [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md). | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AuthResultType](./kibana-plugin-core-server.authresulttype.md) | | -| [AuthStatus](./kibana-plugin-core-server.authstatus.md) | Status indicating an outcome of the authentication. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AppCategory](./kibana-plugin-core-server.appcategory.md) | A category definition for nav links to know where to sort them in the left hand nav | -| [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) | A plugin with asynchronous lifecycle methods. | -| [Authenticated](./kibana-plugin-core-server.authenticated.md) | | -| [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) | | -| [AuthRedirected](./kibana-plugin-core-server.authredirected.md) | | -| [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) | Result of auth redirection. | -| [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) | Result of successful authentication. | -| [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) | A tool set defining an outcome of Auth interceptor for incoming request. | -| [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) | Base properties shared by all types of deprecations | -| [Capabilities](./kibana-plugin-core-server.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. | -| [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | APIs to manage the [Capabilities](./kibana-plugin-core-server.capabilities.md) that will be used by the application.Plugins relying on capabilities to toggle some of their features should register them during the setup phase using the registerProvider method.Plugins having the responsibility to restrict capabilities depending on a given context should register their capabilities switcher using the registerSwitcher method.Refers to the methods documentation for complete description and examples. | -| [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) | APIs to access the application [Capabilities](./kibana-plugin-core-server.capabilities.md). | -| [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) | | -| [ContextSetup](./kibana-plugin-core-server.contextsetup.md) | An object that handles registration of context providers and configuring handlers with context. | -| [CorePreboot](./kibana-plugin-core-server.corepreboot.md) | Context passed to the setup method of preboot plugins. | -| [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) | The core context provided to route handler.Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request | -| [CoreSetup](./kibana-plugin-core-server.coresetup.md) | Context passed to the setup method of standard plugins. | -| [CoreStart](./kibana-plugin-core-server.corestart.md) | Context passed to the plugins start method. | -| [CoreStatus](./kibana-plugin-core-server.corestatus.md) | Status of core services. | -| [CountResponse](./kibana-plugin-core-server.countresponse.md) | | -| [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) | HTTP response parameters for a response with adjustable status code. | -| [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) | | -| [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) | Server-side client that provides access to fetch all Kibana deprecations | -| [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) | UiSettings deprecation field options. | -| [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) | The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version.The Deprecation service is consumed by the upgrade assistant to assist with the upgrade experience.If a deprecated feature can be resolved without manual user intervention. Using correctiveActions.api allows the Upgrade Assistant to use this api to correct the deprecation upon a user trigger. | -| [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) | A limited set of Elasticsearch configuration entries exposed to the preboot plugins at setup. | -| [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) | | -| [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | | -| [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) | | -| [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | | -| [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) | | -| [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters | -| [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) | | -| [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. | -| [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) | | -| [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) | | -| [GetResponse](./kibana-plugin-core-server.getresponse.md) | | -| [HttpAuth](./kibana-plugin-core-server.httpauth.md) | | -| [HttpResources](./kibana-plugin-core-server.httpresources.md) | HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. | -| [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters | -| [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) | Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. | -| [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) | HTTP response parameters | -| [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) | Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md). | -| [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) | Kibana HTTP Service provides an abstraction to work with the HTTP stack at the preboot stage. This functionality allows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and preboot plugins can define HTTP routes at this stage. | -| [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to hapi server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. | -| [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) | | -| [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) | | -| [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via asScoped(...)). | -| [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | An object that handles registration of context providers and configuring handlers with context. | -| [ICspConfig](./kibana-plugin-core-server.icspconfig.md) | CSP configuration for use in Kibana. | -| [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) | See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | -| [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) | | -| [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) | External Url configuration for use in Kibana. | -| [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) | A policy describing whether access to an external destination is allowed. | -| [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) | A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution | -| [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) | A tiny abstraction for TCP socket. | -| [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) | an IntervalHistogram object that samples and reports the event loop delay over time. The delays will be reported in milliseconds. | -| [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) | | -| [IRouter](./kibana-plugin-core-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations. | -| [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) | Utility class used to export savedObjects. | -| [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) | Utility class used to import savedObjects. | -| [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) | | -| [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) | Serves the same purpose as the normal [cluster client](./kibana-plugin-core-server.iclusterclient.md) but exposes an additional asCurrentUser method that doesn't use credentials of the Kibana internal user (as asInternalUser does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API instead. | -| [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) | Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. | -| [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | Request events. | -| [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) | Request specific route information exposed to a handler. | -| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. | -| [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) | | -| [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. | -| [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. | -| [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) | Additional data to extend a response. | -| [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) | Response status code. | -| [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) | Additional data to extend a response when rendering a new body | -| [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) | A tool set defining an outcome of OnPreResponse interceptor for incoming request. | -| [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) | A tool set defining an outcome of OnPreRouting interceptor for incoming request. | -| [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) | Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server. | -| [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) | OS related metrics | -| [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) | Process related metrics | -| [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) | server related metrics | -| [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) | The interface that should be returned by a PluginInitializer for a standard plugin. | -| [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) | Describes a plugin configuration properties. | -| [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. | -| [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. | -| [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) | | -| [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) | The interface that should be returned by a PluginInitializer for a preboot plugin. | -| [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) | Kibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met. | -| [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) | | -| [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Base context passed to a route handler. | -| [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) | \* | -| [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) | Defines a set of additional options for the resolveCapabilities method of [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md). | -| [RouteConfig](./kibana-plugin-core-server.routeconfig.md) | Route specific configuration. | -| [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) | Additional route options. | -| [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) | Additional body options for a route | -| [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) | Validation result factory to be used in the custom validation function to return the valid data or validation errorsSee [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md). | -| [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) | The configuration object to the RouteValidator class. Set params, query and/or body to specify the validation logic to follow for that property. | -| [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) | Additional options for the RouteValidator class to modify its default behaviour. | -| [SavedObject](./kibana-plugin-core-server.savedobject.md) | | -| [SavedObjectAttributes](./kibana-plugin-core-server.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the attributes property. | -| [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) | | -| [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) | Migration context provided when invoking a [migration handler](./kibana-plugin-core-server.savedobjectmigrationfn.md) | -| [SavedObjectMigrationMap](./kibana-plugin-core-server.savedobjectmigrationmap.md) | A map of [migration functions](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions, and they cannot exceed the current Kibana version.For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. | -| [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) | A reference to another saved object. | -| [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) | A returned input object or one of its references, with additional context. | -| [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) | | -| [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) | | -| [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) | | -| [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) | | -| [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) | | -| [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) | | -| [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) | | -| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) | | -| [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) | | -| [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) | | -| [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) | | -| [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) | Options to control the creation of the Saved Objects Client. | -| [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) | Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. | -| [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) | | -| [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) | An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the namespaceType: 'multiple' or namespaceType: 'multiple-isolated' option).Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with the namespaceType: 'multiple'). | -| [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) | Options for collecting references. | -| [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) | The response when object references are collected. | -| [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) | | -| [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) | | -| [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) | | -| [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) | | -| [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) | Options for the [export by objects API](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) | -| [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) | Options for the [export by type API](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) | -| [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) | | -| [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) | Structure of the export result details entry | -| [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) | Context passed down to a [export transform function](./kibana-plugin-core-server.savedobjectsexporttransform.md) | -| [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) | | -| [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) | | -| [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) | Return type of the Saved Objects find() method.\*Note\*: this type is different between the Public and Server Saved Objects clients. | -| [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) | | -| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) | A warning meant to notify that a specific user action is required to finalize the import of some type of object. The actionUrl must be a path relative to the basePath, and not include it. | -| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. | -| [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. | -| [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) | Represents a failure to import. | -| [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) | Result from a [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) | -| [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. | -| [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) | Options to control the import operation. | -| [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) | The response describing the result of an import. | -| [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. | -| [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) | A simple informative warning that will be displayed to the user. | -| [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) | Represents a successful import. | -| [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. | -| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. | -| [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) | | -| [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) | | -| [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) | Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md). | -| [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) | | -| [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) | | -| [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) | | -| [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) | | -| [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. | -| [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) | Options that can be specified when using the saved objects serializer to parse a raw document. | -| [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) | | -| [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) | | -| [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) | Factory provided when invoking a [client factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | -| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. | -| [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) | | -| [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. | -| [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. | -| [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) | Meta information about the SavedObjectService's status. Available to plugins via [CoreSetup.status](./kibana-plugin-core-server.coresetup.status.md). | -| [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) | | -| [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) | Configuration options for the [type](./kibana-plugin-core-server.savedobjectstype.md)'s management section. | -| [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. | -| [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) | An object that should have its spaces updated. | -| [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) | Options for the update operation. | -| [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) | The response when objects' spaces are updated. | -| [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) | Details about a specific object's update result. | -| [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) | | -| [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) | | -| [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) | A map of [validation specs](./kibana-plugin-core-server.savedobjectsvalidationspec.md) to be used for a given type. The map's keys must be valid semver versions.Any time you change the schema of a [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md), you should add a new entry to this map for the Kibana version the change was introduced in. | -| [SearchResponse](./kibana-plugin-core-server.searchresponse.md) | | -| [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) | The current status of a service at a point in time. | -| [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) | Return type from a function to validate cookie contents. | -| [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. | -| [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) | Configuration used to create HTTP session storage based on top of cookie mechanism. | -| [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request | -| [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) | | -| [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) | | -| [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) | API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status. | -| [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. | -| [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) | | -| [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | | -| [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) | | -| [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) | | -| [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) | | -| [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) | | -| [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) | Toolkit passed to a [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) used to generate responses from the handler | -| [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) | Describes the values explicitly set by user. | - -## Variables - -| Variable | Description | -| --- | --- | -| [APP\_WRAPPER\_CLASS](./kibana-plugin-core-server.app_wrapper_class.md) | The class name for top level \*and\* nested application wrappers to ensure proper layout | -| [kibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) | Set of helpers used to create KibanaResponse to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution. | -| [mergeSavedObjectMigrationMaps](./kibana-plugin-core-server.mergesavedobjectmigrationmaps.md) | Merges two saved object migration maps.If there is a migration for a given version on only one of the maps, that migration function will be used:mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }If there is a migration for a given version on both maps, the migrations will be composed:mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } | -| [pollEsNodesVersion](./kibana-plugin-core-server.pollesnodesversion.md) | | -| [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md) | The current "level" of availability of a service. | -| [validBodyOutput](./kibana-plugin-core-server.validbodyoutput.md) | The set of valid body.output | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) | Exposes the public APIs of the AnalyticsClient during the preboot phase | -| [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) | Exposes the public APIs of the AnalyticsClient during the setup phase. | -| [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) | Exposes the public APIs of the AnalyticsClient during the start phase | -| [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md) | See [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md). | -| [AuthHeaders](./kibana-plugin-core-server.authheaders.md) | Auth Headers map | -| [AuthResult](./kibana-plugin-core-server.authresult.md) | | -| [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md) | | -| [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) | | -| [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) | Set of HTTP methods changing the state of the server. | -| [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md) | Client used to query the elasticsearch cluster. | -| [ElasticsearchClientConfig](./kibana-plugin-core-server.elasticsearchclientconfig.md) | Configuration options to be used to create a [cluster client](./kibana-plugin-core-server.iclusterclient.md) using the [createClient API](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | -| [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) | | -| [ExposedToBrowserDescriptor](./kibana-plugin-core-server.exposedtobrowserdescriptor.md) | Type defining the list of configuration properties that will be exposed on the client-side Object properties can either be fully exposed | -| [GetAuthHeaders](./kibana-plugin-core-server.getauthheaders.md) | Get headers to authenticate a user against Elasticsearch. | -| [GetAuthState](./kibana-plugin-core-server.getauthstate.md) | Gets authentication state for a request. Returned by auth interceptor. | -| [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md) | Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) to represent the type of the context. | -| [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) | A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | -| [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) | Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md), excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md). | -| [Headers\_2](./kibana-plugin-core-server.headers_2.md) | Http request headers to read. | -| [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) | Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. | -| [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) | HTTP Resources response parameters | -| [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) | Data send to the client as a response payload. | -| [IBasePath](./kibana-plugin-core-server.ibasepath.md) | Access or manipulate the Kibana base path[BasePath](./kibana-plugin-core-server.basepath.md) | -| [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) | A function that returns a context value for a specific key of given context type. | -| [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) | Returns authentication status for a request. | -| [ISavedObjectsRepository](./kibana-plugin-core-server.isavedobjectsrepository.md) | See [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | -| [ISavedObjectTypeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) | See [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) for documentation. | -| [KibanaExecutionContext](./kibana-plugin-core-server.kibanaexecutioncontext.md) | Represents a meta-information about a Kibana entity initiating a search request. | -| [KibanaRequestRouteOptions](./kibana-plugin-core-server.kibanarequestrouteoptions.md) | Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. | -| [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) | Creates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client. | -| [KnownHeaders](./kibana-plugin-core-server.knownheaders.md) | Set of well-known HTTP headers. | -| [LifecycleResponseFactory](./kibana-plugin-core-server.lifecycleresponsefactory.md) | Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. | -| [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) | List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to true then the actual value of these configs will be reoprted. If parent node or actual config path is set to false then the config will be reported as \[redacted\]. | -| [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) | APIs to retrieves metrics gathered and exposed by the core platform. | -| [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) | Elasticsearch Refresh setting for mutating operation | -| [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md) | See [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md). | -| [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md) | See [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md). | -| [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md) | See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). | -| [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md) | See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). | -| [PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) | Dedicated type for plugin configuration schema. | -| [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) | The plugin export at the root of a plugin's server directory should conform to this interface. | -| [PublicUiSettingsParams](./kibana-plugin-core-server.publicuisettingsparams.md) | A sub-set of [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) exposed to the client-side. | -| [RedirectResponseOptions](./kibana-plugin-core-server.redirectresponseoptions.md) | HTTP response parameters for redirection response | -| [RequestHandler](./kibana-plugin-core-server.requesthandler.md) | A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) functions. If anything else is returned, or an error is thrown, the HTTP service will automatically log the error and respond 500 - Internal Server Error. | -| [RequestHandlerContextContainer](./kibana-plugin-core-server.requesthandlercontextcontainer.md) | An object that handles registration of http request context providers. | -| [RequestHandlerContextProvider](./kibana-plugin-core-server.requesthandlercontextprovider.md) | Context provider for request handler. Extends request context object with provided functionality or data. | -| [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md) | Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function. | -| [ResponseError](./kibana-plugin-core-server.responseerror.md) | Error message and optional data send to the client in case of error. | -| [ResponseErrorAttributes](./kibana-plugin-core-server.responseerrorattributes.md) | Additional data to provide error details. | -| [ResponseHeaders](./kibana-plugin-core-server.responseheaders.md) | Http response headers to set. | -| [RouteContentType](./kibana-plugin-core-server.routecontenttype.md) | The set of supported parseable Content-Types | -| [RouteMethod](./kibana-plugin-core-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. | -| [RouteRegistrar](./kibana-plugin-core-server.routeregistrar.md) | Route handler common definition | -| [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) | The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. | -| [RouteValidationSpec](./kibana-plugin-core-server.routevalidationspec.md) | Allowed property validation options: either @kbn/config-schema validations or custom validation functionsSee [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) for custom validation. | -| [RouteValidatorFullConfig](./kibana-plugin-core-server.routevalidatorfullconfig.md) | Route validations config and options merged into one object | -| [SafeRouteMethod](./kibana-plugin-core-server.saferoutemethod.md) | Set of HTTP methods not changing the state of the server. | -| [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) | Type definition for a Saved Object attribute value | -| [SavedObjectAttributeSingle](./kibana-plugin-core-server.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) | -| [SavedObjectMigrationFn](./kibana-plugin-core-server.savedobjectmigrationfn.md) | A migration function for a [saved object type](./kibana-plugin-core-server.savedobjectstype.md) used to migrate it to a given version | -| [SavedObjectSanitizedDoc](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) | Describes Saved Object documents that have passed through the migration framework and are guaranteed to have a references root property. | -| [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.\#\# SavedObjectsClient errorsSince the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md)Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the isXYZError() helpers exposed at SavedObjectsErrorHelpers should be used to understand and manage error responses from the SavedObjectsClient.Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for error.body.error.type or doing substring checks on error.body.error.reason, just use the helpers to understand the meaning of the error:\`\`\`js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }// always rethrow the error unless you handle it throw error; \`\`\`\#\#\# 404s from missing indexFrom the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistence and that index might be missing.At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | -| [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md) | Describes the factory used to create instances of the Saved Objects Client. | -| [SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) | Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md). | -| [SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. | -| [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) | | -| [SavedObjectsCreatePointInTimeFinderOptions](./kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md) | | -| [SavedObjectsExportTransform](./kibana-plugin-core-server.savedobjectsexporttransform.md) | Transformation function used to mutate the exported objects of the associated type.A type's export transform function will be executed once per user-initiated export, for all objects of that type. | -| [SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md) | Describe a [saved object type mapping](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) field.Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation | -| [SavedObjectsImportHook](./kibana-plugin-core-server.savedobjectsimporthook.md) | A hook associated with a specific saved object type, that will be invoked during the import process. The hook will have access to the objects of the registered type.Currently, the only supported feature for import hooks is to return warnings to be displayed in the UI when the import succeeds. The only interactions the hook can have with the import process is via the hook's response. Mutating the objects inside the hook's code will have no effect. | -| [SavedObjectsImportWarning](./kibana-plugin-core-server.savedobjectsimportwarning.md) | Composite type of all the possible types of import warnings.See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) for more details. | -| [SavedObjectsNamespaceType](./kibana-plugin-core-server.savedobjectsnamespacetype.md) | The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. | -| [SavedObjectsValidationSpec](./kibana-plugin-core-server.savedobjectsvalidationspec.md) | Allows for validating properties using @kbn/config-schema validations. | -| [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) | If defined, allows a type to run a search query and return a query filter that may match any documents which may be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which are no longer needed and may slow the migration process.If this hook fails, the migration will proceed without these documents having been filtered out, so this should not be used as a guarantee that these documents have been deleted.Experimental and subject to change | -| [SavedObjectUnsanitizedDoc](./kibana-plugin-core-server.savedobjectunsanitizeddoc.md) | Describes Saved Object documents from Kibana < 7.0.0 which don't have a references root property defined. This type should only be used in migrations. | -| [ScopeableRequest](./kibana-plugin-core-server.scopeablerequest.md) | A user credentials container. It accommodates the necessary auth credentials to impersonate the current user.See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md). | -| [ServiceStatusLevel](./kibana-plugin-core-server.servicestatuslevel.md) | A convenience type that represents the union of each value in [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md). | -| [SharedGlobalConfig](./kibana-plugin-core-server.sharedglobalconfig.md) | | -| [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers. Promise will not resolve until Core and plugin dependencies have completed start. This should only be used inside handlers registered during setup that will only be executed after start lifecycle. | -| [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) | UI element type to represent the settings. | -| [UnauthorizedError](./kibana-plugin-core-server.unauthorizederror.md) | | -| [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) | A handler used to handle unauthorized error returned by elasticsearch | -| [UnauthorizedErrorHandlerResult](./kibana-plugin-core-server.unauthorizederrorhandlerresult.md) | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md b/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md deleted file mode 100644 index 68cd580b57882..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [mergeSavedObjectMigrationMaps](./kibana-plugin-core-server.mergesavedobjectmigrationmaps.md) - -## mergeSavedObjectMigrationMaps variable - -Merges two saved object migration maps. - -If there is a migration for a given version on only one of the maps, that migration function will be used: - -mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g } - -If there is a migration for a given version on both maps, the migrations will be composed: - -mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } - -Signature: - -```typescript -mergeSavedObjectMigrationMaps: (map1: SavedObjectMigrationMap, map2: SavedObjectMigrationMap) => SavedObjectMigrationMap -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md deleted file mode 100644 index 6f05526b66c83..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) - -## MetricsServiceSetup.collectionInterval property - -Interval metrics are collected in milliseconds - -Signature: - -```typescript -readonly collectionInterval: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md deleted file mode 100644 index 0db06b231f60e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) - -## MetricsServiceSetup.getOpsMetrics$ property - -Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time, based on the `opts.interval` configuration property. - -Signature: - -```typescript -getOpsMetrics$: () => Observable; -``` - -## Example - - -```ts -core.metrics.getOpsMetrics$().subscribe(metrics => { - // do something with the metrics -}) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md deleted file mode 100644 index d9b05589ab6a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) - -## MetricsServiceSetup interface - -APIs to retrieves metrics gathered and exposed by the core platform. - -Signature: - -```typescript -export interface MetricsServiceSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) | number | Interval metrics are collected in milliseconds | -| [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) | () => Observable<OpsMetrics> | Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's start phase, and a new value every fixed interval of time, based on the opts.interval configuration property. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md deleted file mode 100644 index 8b3280d528c18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) - -## MetricsServiceStart type - -APIs to retrieves metrics gathered and exposed by the core platform. - -Signature: - -```typescript -export declare type MetricsServiceStart = MetricsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md b/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md deleted file mode 100644 index 6fb93e39c9805..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) - -## MutatingOperationRefreshSetting type - -Elasticsearch Refresh setting for mutating operation - -Signature: - -```typescript -export declare type MutatingOperationRefreshSetting = boolean | 'wait_for'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md deleted file mode 100644 index 8e7298d28801c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [incompatibleNodes](./kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md) - -## NodesVersionCompatibility.incompatibleNodes property - -Signature: - -```typescript -incompatibleNodes: NodeInfo[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md deleted file mode 100644 index 82a4800a3b4b6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [isCompatible](./kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md) - -## NodesVersionCompatibility.isCompatible property - -Signature: - -```typescript -isCompatible: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md deleted file mode 100644 index 347f2d3474b11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [kibanaVersion](./kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md) - -## NodesVersionCompatibility.kibanaVersion property - -Signature: - -```typescript -kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md deleted file mode 100644 index a282bf4b7b4b6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) - -## NodesVersionCompatibility interface - -Signature: - -```typescript -export interface NodesVersionCompatibility -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [incompatibleNodes](./kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md) | NodeInfo\[\] | | -| [isCompatible](./kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md) | boolean | | -| [kibanaVersion](./kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md) | string | | -| [message?](./kibana-plugin-core-server.nodesversioncompatibility.message.md) | string | (Optional) | -| [nodesInfoRequestError?](./kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md) | Error | (Optional) | -| [warningNodes](./kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md) | NodeInfo\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md deleted file mode 100644 index 415a7825ee2bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [message](./kibana-plugin-core-server.nodesversioncompatibility.message.md) - -## NodesVersionCompatibility.message property - -Signature: - -```typescript -message?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md deleted file mode 100644 index aa9421afed6e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [nodesInfoRequestError](./kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md) - -## NodesVersionCompatibility.nodesInfoRequestError property - -Signature: - -```typescript -nodesInfoRequestError?: Error; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md deleted file mode 100644 index 6c017e9fc800c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [warningNodes](./kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md) - -## NodesVersionCompatibility.warningNodes property - -Signature: - -```typescript -warningNodes: NodeInfo[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md deleted file mode 100644 index 2bc48928f57c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md) - -## OnPostAuthHandler type - -See [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md). - -Signature: - -```typescript -export declare type OnPostAuthHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPostAuthToolkit) => OnPostAuthResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md deleted file mode 100644 index 069f63fe01b77..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) - -## OnPostAuthToolkit interface - -A tool set defining an outcome of OnPostAuth interceptor for incoming request. - -Signature: - -```typescript -export interface OnPostAuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpostauthtoolkit.next.md) | () => OnPostAuthResult | To pass request to the next handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md deleted file mode 100644 index a633942cb030f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) > [next](./kibana-plugin-core-server.onpostauthtoolkit.next.md) - -## OnPostAuthToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPostAuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md deleted file mode 100644 index b2997a29f6826..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md) - -## OnPreAuthHandler type - -See [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md). - -Signature: - -```typescript -export declare type OnPreAuthHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPreAuthToolkit) => OnPreAuthResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md deleted file mode 100644 index 44eed5818c610..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) - -## OnPreAuthToolkit interface - -A tool set defining an outcome of OnPreAuth interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreAuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreauthtoolkit.next.md) | () => OnPreAuthResult | To pass request to the next handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md deleted file mode 100644 index 96776b374cb84..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) > [next](./kibana-plugin-core-server.onpreauthtoolkit.next.md) - -## OnPreAuthToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPreAuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md deleted file mode 100644 index f05976b029f9d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) > [headers](./kibana-plugin-core-server.onpreresponseextensions.headers.md) - -## OnPreResponseExtensions.headers property - -additional headers to attach to the response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md deleted file mode 100644 index 078ccc38a70c1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) - -## OnPreResponseExtensions interface - -Additional data to extend a response. - -Signature: - -```typescript -export interface OnPreResponseExtensions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers?](./kibana-plugin-core-server.onpreresponseextensions.headers.md) | ResponseHeaders | (Optional) additional headers to attach to the response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md deleted file mode 100644 index 10696fb79a2f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md) - -## OnPreResponseHandler type - -See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). - -Signature: - -```typescript -export declare type OnPreResponseHandler = (request: KibanaRequest, preResponse: OnPreResponseInfo, toolkit: OnPreResponseToolkit) => OnPreResponseResult | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md deleted file mode 100644 index 60f7f39ed30a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) - -## OnPreResponseInfo interface - -Response status code. - -Signature: - -```typescript -export interface OnPreResponseInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [statusCode](./kibana-plugin-core-server.onpreresponseinfo.statuscode.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md deleted file mode 100644 index fb2ced48e8961..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) > [statusCode](./kibana-plugin-core-server.onpreresponseinfo.statuscode.md) - -## OnPreResponseInfo.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md deleted file mode 100644 index ab5b5e7a4f272..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) > [body](./kibana-plugin-core-server.onpreresponserender.body.md) - -## OnPreResponseRender.body property - -the body to use in the response - -Signature: - -```typescript -body: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md deleted file mode 100644 index 100d12f63d165..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) > [headers](./kibana-plugin-core-server.onpreresponserender.headers.md) - -## OnPreResponseRender.headers property - -additional headers to attach to the response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md deleted file mode 100644 index a5afa1a709326..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) - -## OnPreResponseRender interface - -Additional data to extend a response when rendering a new body - -Signature: - -```typescript -export interface OnPreResponseRender -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body](./kibana-plugin-core-server.onpreresponserender.body.md) | string | the body to use in the response | -| [headers?](./kibana-plugin-core-server.onpreresponserender.headers.md) | ResponseHeaders | (Optional) additional headers to attach to the response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md deleted file mode 100644 index 197b7b692e734..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) - -## OnPreResponseToolkit interface - -A tool set defining an outcome of OnPreResponse interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreResponseToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreresponsetoolkit.next.md) | (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult | To pass request to the next handler | -| [render](./kibana-plugin-core-server.onpreresponsetoolkit.render.md) | (responseRender: OnPreResponseRender) => OnPreResponseResult | To override the response with a different body | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md deleted file mode 100644 index 236c3f9bb7419..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) > [next](./kibana-plugin-core-server.onpreresponsetoolkit.next.md) - -## OnPreResponseToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md deleted file mode 100644 index 7dced7fe8deee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) > [render](./kibana-plugin-core-server.onpreresponsetoolkit.render.md) - -## OnPreResponseToolkit.render property - -To override the response with a different body - -Signature: - -```typescript -render: (responseRender: OnPreResponseRender) => OnPreResponseResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md deleted file mode 100644 index 46016bcd5476a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md) - -## OnPreRoutingHandler type - -See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). - -Signature: - -```typescript -export declare type OnPreRoutingHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPreRoutingToolkit) => OnPreRoutingResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md deleted file mode 100644 index e3bdeb3c451c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) - -## OnPreRoutingToolkit interface - -A tool set defining an outcome of OnPreRouting interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreRoutingToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreroutingtoolkit.next.md) | () => OnPreRoutingResult | To pass request to the next handler | -| [rewriteUrl](./kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md) | (url: string) => OnPreRoutingResult | Rewrite requested resources url before is was authenticated and routed to a handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md deleted file mode 100644 index 7fb0b2ce67ba5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) > [next](./kibana-plugin-core-server.onpreroutingtoolkit.next.md) - -## OnPreRoutingToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPreRoutingResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md deleted file mode 100644 index 346a12711c723..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) > [rewriteUrl](./kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md) - -## OnPreRoutingToolkit.rewriteUrl property - -Rewrite requested resources url before is was authenticated and routed to a handler - -Signature: - -```typescript -rewriteUrl: (url: string) => OnPreRoutingResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md deleted file mode 100644 index 25125569b7b38..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) - -## OpsMetrics.collected\_at property - -Time metrics were recorded at. - -Signature: - -```typescript -collected_at: Date; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md deleted file mode 100644 index 18d1dc7d13ece..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) - -## OpsMetrics.concurrent\_connections property - -number of current concurrent connections to the server - -Signature: - -```typescript -concurrent_connections: OpsServerMetrics['concurrent_connections']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md deleted file mode 100644 index dcecfd35a8d2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) - -## OpsMetrics interface - -Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server. - -Signature: - -```typescript -export interface OpsMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) | Date | Time metrics were recorded at. | -| [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) | OpsServerMetrics\['concurrent\_connections'\] | number of current concurrent connections to the server | -| [os](./kibana-plugin-core-server.opsmetrics.os.md) | OpsOsMetrics | OS related metrics | -| [process](./kibana-plugin-core-server.opsmetrics.process.md) | OpsProcessMetrics | Process related metrics. | -| [processes](./kibana-plugin-core-server.opsmetrics.processes.md) | OpsProcessMetrics\[\] | Process related metrics. Reports an array of objects for each kibana pid. | -| [requests](./kibana-plugin-core-server.opsmetrics.requests.md) | OpsServerMetrics\['requests'\] | server requests stats | -| [response\_times](./kibana-plugin-core-server.opsmetrics.response_times.md) | OpsServerMetrics\['response\_times'\] | server response time stats | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md deleted file mode 100644 index a893c847f48be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [os](./kibana-plugin-core-server.opsmetrics.os.md) - -## OpsMetrics.os property - -OS related metrics - -Signature: - -```typescript -os: OpsOsMetrics; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md deleted file mode 100644 index fa91e8b295b6e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [process](./kibana-plugin-core-server.opsmetrics.process.md) - -## OpsMetrics.process property - -> Warning: This API is now obsolete. -> -> use the processes field instead. 8.8.0 -> - -Process related metrics. - -Signature: - -```typescript -process: OpsProcessMetrics; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md deleted file mode 100644 index cf1f0a7c54475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [processes](./kibana-plugin-core-server.opsmetrics.processes.md) - -## OpsMetrics.processes property - -Process related metrics. Reports an array of objects for each kibana pid. - -Signature: - -```typescript -processes: OpsProcessMetrics[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md deleted file mode 100644 index 36d0f445fa8b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [requests](./kibana-plugin-core-server.opsmetrics.requests.md) - -## OpsMetrics.requests property - -server requests stats - -Signature: - -```typescript -requests: OpsServerMetrics['requests']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md deleted file mode 100644 index 6eeef7f607615..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [response\_times](./kibana-plugin-core-server.opsmetrics.response_times.md) - -## OpsMetrics.response\_times property - -server response time stats - -Signature: - -```typescript -response_times: OpsServerMetrics['response_times']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md deleted file mode 100644 index 095c45266a251..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md) - -## OpsOsMetrics.cpu property - -cpu cgroup metrics, undefined when not running in a cgroup - -Signature: - -```typescript -cpu?: { - control_group: string; - cfs_period_micros: number; - cfs_quota_micros: number; - stat: { - number_of_elapsed_periods: number; - number_of_times_throttled: number; - time_throttled_nanos: number; - }; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md deleted file mode 100644 index 140646a0d1a35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) - -## OpsOsMetrics.cpuacct property - -cpu accounting metrics, undefined when not running in a cgroup - -Signature: - -```typescript -cpuacct?: { - control_group: string; - usage_nanos: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md deleted file mode 100644 index ef0f46cc220c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [distro](./kibana-plugin-core-server.opsosmetrics.distro.md) - -## OpsOsMetrics.distro property - -The os distrib. Only present for linux platforms - -Signature: - -```typescript -distro?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md deleted file mode 100644 index 88bf59888a55e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [distroRelease](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) - -## OpsOsMetrics.distroRelease property - -The os distrib release, prefixed by the os distrib. Only present for linux platforms - -Signature: - -```typescript -distroRelease?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md deleted file mode 100644 index 060086cc26def..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [load](./kibana-plugin-core-server.opsosmetrics.load.md) - -## OpsOsMetrics.load property - -cpu load metrics - -Signature: - -```typescript -load: { - '1m': number; - '5m': number; - '15m': number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md deleted file mode 100644 index 08f205d48dd09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) - -## OpsOsMetrics interface - -OS related metrics - -Signature: - -```typescript -export interface OpsOsMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [cpu?](./kibana-plugin-core-server.opsosmetrics.cpu.md) | { control\_group: string; cfs\_period\_micros: number; cfs\_quota\_micros: number; stat: { number\_of\_elapsed\_periods: number; number\_of\_times\_throttled: number; time\_throttled\_nanos: number; }; } | (Optional) cpu cgroup metrics, undefined when not running in a cgroup | -| [cpuacct?](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) | { control\_group: string; usage\_nanos: number; } | (Optional) cpu accounting metrics, undefined when not running in a cgroup | -| [distro?](./kibana-plugin-core-server.opsosmetrics.distro.md) | string | (Optional) The os distrib. Only present for linux platforms | -| [distroRelease?](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) | string | (Optional) The os distrib release, prefixed by the os distrib. Only present for linux platforms | -| [load](./kibana-plugin-core-server.opsosmetrics.load.md) | { '1m': number; '5m': number; '15m': number; } | cpu load metrics | -| [memory](./kibana-plugin-core-server.opsosmetrics.memory.md) | { total\_in\_bytes: number; free\_in\_bytes: number; used\_in\_bytes: number; } | system memory usage metrics | -| [platform](./kibana-plugin-core-server.opsosmetrics.platform.md) | NodeJS.Platform | The os platform | -| [platformRelease](./kibana-plugin-core-server.opsosmetrics.platformrelease.md) | string | The os platform release, prefixed by the platform name | -| [uptime\_in\_millis](./kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md) | number | the OS uptime | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md deleted file mode 100644 index 10ff674cbda87..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [memory](./kibana-plugin-core-server.opsosmetrics.memory.md) - -## OpsOsMetrics.memory property - -system memory usage metrics - -Signature: - -```typescript -memory: { - total_in_bytes: number; - free_in_bytes: number; - used_in_bytes: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md deleted file mode 100644 index 0f4bbf81e2514..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [platform](./kibana-plugin-core-server.opsosmetrics.platform.md) - -## OpsOsMetrics.platform property - -The os platform - -Signature: - -```typescript -platform: NodeJS.Platform; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md deleted file mode 100644 index b82898ddda632..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [platformRelease](./kibana-plugin-core-server.opsosmetrics.platformrelease.md) - -## OpsOsMetrics.platformRelease property - -The os platform release, prefixed by the platform name - -Signature: - -```typescript -platformRelease: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md deleted file mode 100644 index fcae35f02cb80..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [uptime\_in\_millis](./kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md) - -## OpsOsMetrics.uptime\_in\_millis property - -the OS uptime - -Signature: - -```typescript -uptime_in_millis: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md deleted file mode 100644 index d626b9cf8f98c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [event\_loop\_delay](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md) - -## OpsProcessMetrics.event\_loop\_delay property - -mean event loop delay since last collection - -Signature: - -```typescript -event_loop_delay: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md deleted file mode 100644 index 1d870b19f2d1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [event\_loop\_delay\_histogram](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md) - -## OpsProcessMetrics.event\_loop\_delay\_histogram property - -node event loop delay histogram since last collection - -Signature: - -```typescript -event_loop_delay_histogram: IntervalHistogram; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md deleted file mode 100644 index 43a4333d7bd2c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) - -## OpsProcessMetrics interface - -Process related metrics - -Signature: - -```typescript -export interface OpsProcessMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event\_loop\_delay\_histogram](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md) | IntervalHistogram | node event loop delay histogram since last collection | -| [event\_loop\_delay](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md) | number | mean event loop delay since last collection | -| [memory](./kibana-plugin-core-server.opsprocessmetrics.memory.md) | { heap: { total\_in\_bytes: number; used\_in\_bytes: number; size\_limit: number; }; resident\_set\_size\_in\_bytes: number; } | process memory usage | -| [pid](./kibana-plugin-core-server.opsprocessmetrics.pid.md) | number | pid of the kibana process | -| [uptime\_in\_millis](./kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md) | number | uptime of the kibana process | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md deleted file mode 100644 index 3bb4aee9f27d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [memory](./kibana-plugin-core-server.opsprocessmetrics.memory.md) - -## OpsProcessMetrics.memory property - -process memory usage - -Signature: - -```typescript -memory: { - heap: { - total_in_bytes: number; - used_in_bytes: number; - size_limit: number; - }; - resident_set_size_in_bytes: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md deleted file mode 100644 index a324d758d08cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [pid](./kibana-plugin-core-server.opsprocessmetrics.pid.md) - -## OpsProcessMetrics.pid property - -pid of the kibana process - -Signature: - -```typescript -pid: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md deleted file mode 100644 index 9879ce44bce1e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [uptime\_in\_millis](./kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md) - -## OpsProcessMetrics.uptime\_in\_millis property - -uptime of the kibana process - -Signature: - -```typescript -uptime_in_millis: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md deleted file mode 100644 index 30fdee9b958e4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [concurrent\_connections](./kibana-plugin-core-server.opsservermetrics.concurrent_connections.md) - -## OpsServerMetrics.concurrent\_connections property - -number of current concurrent connections to the server - -Signature: - -```typescript -concurrent_connections: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md deleted file mode 100644 index ddabbd124627b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) - -## OpsServerMetrics interface - -server related metrics - -Signature: - -```typescript -export interface OpsServerMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [concurrent\_connections](./kibana-plugin-core-server.opsservermetrics.concurrent_connections.md) | number | number of current concurrent connections to the server | -| [requests](./kibana-plugin-core-server.opsservermetrics.requests.md) | { disconnects: number; total: number; statusCodes: Record<number, number>; } | server requests stats | -| [response\_times](./kibana-plugin-core-server.opsservermetrics.response_times.md) | { avg\_in\_millis: number; max\_in\_millis: number; } | server response time stats | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md deleted file mode 100644 index 7439b1017e72c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [requests](./kibana-plugin-core-server.opsservermetrics.requests.md) - -## OpsServerMetrics.requests property - -server requests stats - -Signature: - -```typescript -requests: { - disconnects: number; - total: number; - statusCodes: Record; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md deleted file mode 100644 index be66b0b1c1c79..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [response\_times](./kibana-plugin-core-server.opsservermetrics.response_times.md) - -## OpsServerMetrics.response\_times property - -server response time stats - -Signature: - -```typescript -response_times: { - avg_in_millis: number; - max_in_millis: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.md deleted file mode 100644 index 79dbbb56c86fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) - -## Plugin\_2 interface - -The interface that should be returned by a `PluginInitializer` for a `standard` plugin. - -Signature: - -```typescript -export interface Plugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.plugin_2.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-server.plugin_2.start.md) | | -| [stop()?](./kibana-plugin-core-server.plugin_2.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md deleted file mode 100644 index cedce40b58000..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [setup](./kibana-plugin-core-server.plugin_2.setup.md) - -## Plugin\_2.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md deleted file mode 100644 index 08eb5431a2cf2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [start](./kibana-plugin-core-server.plugin_2.start.md) - -## Plugin\_2.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md deleted file mode 100644 index 5b62a5e82b2ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [stop](./kibana-plugin-core-server.plugin_2.stop.md) - -## Plugin\_2.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md deleted file mode 100644 index d06b3cb9fa64a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [deprecations](./kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md) - -## PluginConfigDescriptor.deprecations property - -Provider for the to apply to the plugin configuration. - -Signature: - -```typescript -deprecations?: ConfigDeprecationProvider; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md deleted file mode 100644 index 212a0d1c9a26b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [exposeToBrowser](./kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md) - -## PluginConfigDescriptor.exposeToBrowser property - -List of configuration properties that will be available on the client-side plugin. - -Signature: - -```typescript -exposeToBrowser?: ExposedToBrowserDescriptor; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md deleted file mode 100644 index 8c50c2e339426..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [exposeToUsage](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md) - -## PluginConfigDescriptor.exposeToUsage property - -Expose non-default configs to usage collection to be sent via telemetry. set a config to `true` to report the actual changed config value. set a config to `false` to report the changed config value as \[redacted\]. - -All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified. - -[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) - -Signature: - -```typescript -exposeToUsage?: MakeUsageFromSchema; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md deleted file mode 100644 index f5d18c9f40f4d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md +++ /dev/null @@ -1,50 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) - -## PluginConfigDescriptor interface - -Describes a plugin configuration properties. - -Signature: - -```typescript -export interface PluginConfigDescriptor -``` - -## Example - - -```typescript -// my_plugin/server/index.ts -import { schema, TypeOf } from '@kbn/config-schema'; -import { PluginConfigDescriptor } from 'kibana/server'; - -const configSchema = schema.object({ - secret: schema.string({ defaultValue: 'Only on server' }), - uiProp: schema.string({ defaultValue: 'Accessible from client' }), -}); - -type ConfigType = TypeOf; - -export const config: PluginConfigDescriptor = { - exposeToBrowser: { - uiProp: true, - }, - schema: configSchema, - deprecations: ({ rename, unused }) => [ - rename('securityKey', 'secret'), - unused('deprecatedProperty'), - ], -}; -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecations?](./kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md) | ConfigDeprecationProvider | (Optional) Provider for the to apply to the plugin configuration. | -| [exposeToBrowser?](./kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md) | ExposedToBrowserDescriptor<T> | (Optional) List of configuration properties that will be available on the client-side plugin. | -| [exposeToUsage?](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md) | MakeUsageFromSchema<T> | (Optional) Expose non-default configs to usage collection to be sent via telemetry. set a config to true to report the actual changed config value. set a config to false to report the changed config value as \[redacted\].All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified.[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) | -| [schema](./kibana-plugin-core-server.pluginconfigdescriptor.schema.md) | PluginConfigSchema<T> | Schema to use to validate the plugin configuration.[PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md deleted file mode 100644 index 700b311d941a8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [schema](./kibana-plugin-core-server.pluginconfigdescriptor.schema.md) - -## PluginConfigDescriptor.schema property - -Schema to use to validate the plugin configuration. - -[PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) - -Signature: - -```typescript -schema: PluginConfigSchema; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md deleted file mode 100644 index 6f4c60975b48c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) - -## PluginConfigSchema type - -Dedicated type for plugin configuration schema. - -Signature: - -```typescript -export declare type PluginConfigSchema = Type; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md deleted file mode 100644 index 9b4d1b022db2a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) - -## PluginInitializer type - -The `plugin` export at the root of a plugin's `server` directory should conform to this interface. - -Signature: - -```typescript -export declare type PluginInitializer = (core: PluginInitializerContext) => Plugin | PrebootPlugin | AsyncPlugin; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md deleted file mode 100644 index 3b5754eb4fa39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [config](./kibana-plugin-core-server.plugininitializercontext.config.md) - -## PluginInitializerContext.config property - -Accessors for the plugin's configuration - -Signature: - -```typescript -config: { - legacy: { - globalConfig$: Observable; - get: () => SharedGlobalConfig; - }; - create: () => Observable; - get: () => T; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md deleted file mode 100644 index 534f532850587..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [env](./kibana-plugin-core-server.plugininitializercontext.env.md) - -## PluginInitializerContext.env property - -Signature: - -```typescript -env: { - mode: EnvironmentMode; - packageInfo: Readonly; - instanceUuid: string; - configs: readonly string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md deleted file mode 100644 index 74bf5b0c1384c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [logger](./kibana-plugin-core-server.plugininitializercontext.logger.md) - -## PluginInitializerContext.logger property - - instance already bound to the plugin's logging context - -Signature: - -```typescript -logger: LoggerFactory; -``` - -## Example - - -```typescript -// plugins/my-plugin/server/plugin.ts -// "id: myPlugin" in `plugins/my-plugin/kibana.yaml` - -export class MyPlugin implements Plugin { - constructor(private readonly initContext: PluginInitializerContext) { - this.logger = initContext.logger.get(); - // `logger` context: `plugins.myPlugin` - this.mySubLogger = initContext.logger.get('sub'); // or this.logger.get('sub'); - // `mySubLogger` context: `plugins.myPlugin.sub` - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md deleted file mode 100644 index e2d115578d7c1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) - -## PluginInitializerContext interface - -Context that's available to plugins during initialization stage. - -Signature: - -```typescript -export interface PluginInitializerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-server.plugininitializercontext.config.md) | { legacy: { globalConfig$: Observable<SharedGlobalConfig>; get: () => SharedGlobalConfig; }; create: <T = ConfigSchema>() => Observable<T>; get: <T = ConfigSchema>() => T; } | Accessors for the plugin's configuration | -| [env](./kibana-plugin-core-server.plugininitializercontext.env.md) | { mode: EnvironmentMode; packageInfo: Readonly<PackageInfo>; instanceUuid: string; configs: readonly string\[\]; } | | -| [logger](./kibana-plugin-core-server.plugininitializercontext.logger.md) | LoggerFactory | instance already bound to the plugin's logging context | -| [opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) | PluginOpaqueId | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md deleted file mode 100644 index 6e2ef10114687..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) - -## PluginInitializerContext.opaqueId property - -Signature: - -```typescript -opaqueId: PluginOpaqueId; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md deleted file mode 100644 index 8aa603242df8e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [configPath](./kibana-plugin-core-server.pluginmanifest.configpath.md) - -## PluginManifest.configPath property - -Root used by the plugin, defaults to "id" in snake\_case format. - -Signature: - -```typescript -readonly configPath: ConfigPath; -``` - -## Example - -id: myPlugin configPath: my\_plugin - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md deleted file mode 100644 index b6bba3b5e356c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [description](./kibana-plugin-core-server.pluginmanifest.description.md) - -## PluginManifest.description property - -TODO: make required once all plugins specify this. A brief description of what this plugin does and any capabilities it provides. - -Signature: - -```typescript -readonly description?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md deleted file mode 100644 index 359e84c67cac2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [enabledOnAnonymousPages](./kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md) - -## PluginManifest.enabledOnAnonymousPages property - -Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. - -Signature: - -```typescript -readonly enabledOnAnonymousPages?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md deleted file mode 100644 index fc1b3a800720d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [extraPublicDirs](./kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md) - -## PluginManifest.extraPublicDirs property - -> Warning: This API is now obsolete. -> -> To be deleted when https://github.com/elastic/kibana/issues/101948 is done. -> - -Specifies directory names that can be imported by other ui-plugins built using the same instance of the @kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins - -Signature: - -```typescript -readonly extraPublicDirs?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md deleted file mode 100644 index 7a846f99c0bbb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [id](./kibana-plugin-core-server.pluginmanifest.id.md) - -## PluginManifest.id property - -Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. - -Signature: - -```typescript -readonly id: PluginName; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md deleted file mode 100644 index 822e280172138..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [kibanaVersion](./kibana-plugin-core-server.pluginmanifest.kibanaversion.md) - -## PluginManifest.kibanaVersion property - -The version of Kibana the plugin is compatible with, defaults to "version". - -Signature: - -```typescript -readonly kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md deleted file mode 100644 index eb3ba06c311c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) - -## PluginManifest interface - -Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. - -Signature: - -```typescript -export interface PluginManifest -``` - -## Remarks - -Should never be used in code outside of Core but is exported for documentation purposes. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [configPath](./kibana-plugin-core-server.pluginmanifest.configpath.md) | ConfigPath | Root used by the plugin, defaults to "id" in snake\_case format. | -| [description?](./kibana-plugin-core-server.pluginmanifest.description.md) | string | (Optional) TODO: make required once all plugins specify this. A brief description of what this plugin does and any capabilities it provides. | -| [enabledOnAnonymousPages?](./kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md) | boolean | (Optional) Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. | -| [extraPublicDirs?](./kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md) | string\[\] | (Optional) Specifies directory names that can be imported by other ui-plugins built using the same instance of the @kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins | -| [id](./kibana-plugin-core-server.pluginmanifest.id.md) | PluginName | Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. | -| [kibanaVersion](./kibana-plugin-core-server.pluginmanifest.kibanaversion.md) | string | The version of Kibana the plugin is compatible with, defaults to "version". | -| [optionalPlugins](./kibana-plugin-core-server.pluginmanifest.optionalplugins.md) | readonly PluginName\[\] | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. | -| [owner](./kibana-plugin-core-server.pluginmanifest.owner.md) | { readonly name: string; readonly githubTeam?: string; } | | -| [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) | readonly string\[\] | List of plugin ids that this plugin's UI code imports modules from that are not in requiredPlugins. | -| [requiredPlugins](./kibana-plugin-core-server.pluginmanifest.requiredplugins.md) | readonly PluginName\[\] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. | -| [server](./kibana-plugin-core-server.pluginmanifest.server.md) | boolean | Specifies whether plugin includes some server-side specific functionality. | -| [serviceFolders?](./kibana-plugin-core-server.pluginmanifest.servicefolders.md) | readonly string\[\] | (Optional) Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections. | -| [type](./kibana-plugin-core-server.pluginmanifest.type.md) | PluginType | Type of the plugin, defaults to standard. | -| [ui](./kibana-plugin-core-server.pluginmanifest.ui.md) | boolean | Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via public/ui_plugin.js file. | -| [version](./kibana-plugin-core-server.pluginmanifest.version.md) | string | Version of the plugin. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md deleted file mode 100644 index 5b75b559dfb7e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [optionalPlugins](./kibana-plugin-core-server.pluginmanifest.optionalplugins.md) - -## PluginManifest.optionalPlugins property - -An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. - -Signature: - -```typescript -readonly optionalPlugins: readonly PluginName[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md deleted file mode 100644 index 06b97a0313de5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [owner](./kibana-plugin-core-server.pluginmanifest.owner.md) - -## PluginManifest.owner property - -Signature: - -```typescript -readonly owner: { - readonly name: string; - readonly githubTeam?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md deleted file mode 100644 index 98505d07101fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) - -## PluginManifest.requiredBundles property - -List of plugin ids that this plugin's UI code imports modules from that are not in `requiredPlugins`. - -Signature: - -```typescript -readonly requiredBundles: readonly string[]; -``` - -## Remarks - -The plugins listed here will be loaded in the browser, even if the plugin is disabled. Required by `@kbn/optimizer` to support cross-plugin imports. "core" and plugins already listed in `requiredPlugins` do not need to be duplicated here. - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md deleted file mode 100644 index 6cab4b537261b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [requiredPlugins](./kibana-plugin-core-server.pluginmanifest.requiredplugins.md) - -## PluginManifest.requiredPlugins property - -An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. - -Signature: - -```typescript -readonly requiredPlugins: readonly PluginName[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md deleted file mode 100644 index 823871bdb1435..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [server](./kibana-plugin-core-server.pluginmanifest.server.md) - -## PluginManifest.server property - -Specifies whether plugin includes some server-side specific functionality. - -Signature: - -```typescript -readonly server: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md deleted file mode 100644 index 8ee33bdfa0f3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [serviceFolders](./kibana-plugin-core-server.pluginmanifest.servicefolders.md) - -## PluginManifest.serviceFolders property - -Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections. - -Signature: - -```typescript -readonly serviceFolders?: readonly string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md deleted file mode 100644 index 6e82132919f6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [type](./kibana-plugin-core-server.pluginmanifest.type.md) - -## PluginManifest.type property - -Type of the plugin, defaults to `standard`. - -Signature: - -```typescript -readonly type: PluginType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md deleted file mode 100644 index c3fa5009b94f8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [ui](./kibana-plugin-core-server.pluginmanifest.ui.md) - -## PluginManifest.ui property - -Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via `public/ui_plugin.js` file. - -Signature: - -```typescript -readonly ui: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md deleted file mode 100644 index 1cd6051a59a10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [version](./kibana-plugin-core-server.pluginmanifest.version.md) - -## PluginManifest.version property - -Version of the plugin. - -Signature: - -```typescript -readonly version: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md deleted file mode 100644 index 78094c5556f31..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [pollEsNodesVersion](./kibana-plugin-core-server.pollesnodesversion.md) - -## pollEsNodesVersion variable - - -Signature: - -```typescript -pollEsNodesVersion: ({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: PollEsNodesVersionOptions) => Observable -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md deleted file mode 100644 index 74ad0abb0ed4f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [esVersionCheckInterval](./kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md) - -## PollEsNodesVersionOptions.esVersionCheckInterval property - -Signature: - -```typescript -esVersionCheckInterval: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md deleted file mode 100644 index 5ec1c7e527814..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [ignoreVersionMismatch](./kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md) - -## PollEsNodesVersionOptions.ignoreVersionMismatch property - -Signature: - -```typescript -ignoreVersionMismatch: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md deleted file mode 100644 index 50880bc510dfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [internalClient](./kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md) - -## PollEsNodesVersionOptions.internalClient property - -Signature: - -```typescript -internalClient: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md deleted file mode 100644 index 4a4d25ec606d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [kibanaVersion](./kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md) - -## PollEsNodesVersionOptions.kibanaVersion property - -Signature: - -```typescript -kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md deleted file mode 100644 index 180b6ee91953b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [log](./kibana-plugin-core-server.pollesnodesversionoptions.log.md) - -## PollEsNodesVersionOptions.log property - -Signature: - -```typescript -log: Logger; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md deleted file mode 100644 index 130898889c66a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) - -## PollEsNodesVersionOptions interface - - -Signature: - -```typescript -export interface PollEsNodesVersionOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [esVersionCheckInterval](./kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md) | number | | -| [ignoreVersionMismatch](./kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md) | boolean | | -| [internalClient](./kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md) | ElasticsearchClient | | -| [kibanaVersion](./kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md) | string | | -| [log](./kibana-plugin-core-server.pollesnodesversionoptions.log.md) | Logger | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md deleted file mode 100644 index 8bbb042965dde..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) - -## PrebootPlugin interface - -The interface that should be returned by a `PluginInitializer` for a `preboot` plugin. - -Signature: - -```typescript -export interface PrebootPlugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.prebootplugin.setup.md) | | -| [stop()?](./kibana-plugin-core-server.prebootplugin.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md deleted file mode 100644 index f55819eeaca57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [setup](./kibana-plugin-core-server.prebootplugin.setup.md) - -## PrebootPlugin.setup() method - -Signature: - -```typescript -setup(core: CorePreboot, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CorePreboot | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md deleted file mode 100644 index c93dcb7709a11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [stop](./kibana-plugin-core-server.prebootplugin.stop.md) - -## PrebootPlugin.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md deleted file mode 100644 index 7f158b46d1f06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) > [holdSetupUntilResolved](./kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md) - -## PrebootServicePreboot.holdSetupUntilResolved property - -Registers a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple times and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises` instances are resolved, or it will shut down if any of them is rejected. - -Signature: - -```typescript -readonly holdSetupUntilResolved: (reason: string, promise: Promise<{ - shouldReloadConfig: boolean; - } | undefined>) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md deleted file mode 100644 index 1ba079da03208..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) > [isSetupOnHold](./kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md) - -## PrebootServicePreboot.isSetupOnHold property - -Indicates whether Kibana is currently on hold and cannot proceed to `setup` yet. - -Signature: - -```typescript -readonly isSetupOnHold: () => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md deleted file mode 100644 index c9c7c15ac3275..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) - -## PrebootServicePreboot interface - -Kibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met. - -Signature: - -```typescript -export interface PrebootServicePreboot -``` - -## Example - -A plugin can supply a `Promise` to a `holdSetupUntilResolved` method to signal Kibana to initialize and start `standard` plugins only after this `Promise` is resolved. If `Promise` is rejected, Kibana will shut down. - -```ts -core.preboot.holdSetupUntilResolved('Just waiting for 5 seconds', - new Promise((resolve) => { - setTimeout(resolve, 5000); - }) -); -``` -If the supplied `Promise` resolves to an object with the `shouldReloadConfig` property set to `true`, Kibana will also reload its configuration from disk. - -```ts -let completeSetup: (result: { shouldReloadConfig: boolean }) => void; -core.preboot.holdSetupUntilResolved('Just waiting for 5 seconds before reloading configuration', - new Promise<{ shouldReloadConfig: boolean }>((resolve) => { - setTimeout(() => resolve({ shouldReloadConfig: true }), 5000); - }) -); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [holdSetupUntilResolved](./kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md) | (reason: string, promise: Promise<{ shouldReloadConfig: boolean; } \| undefined>) => void | Registers a Promise as a precondition before Kibana can proceed to setup. This method can be invoked multiple times and from multiple preboot plugins. Kibana will proceed to setup only when all registered Promises instances are resolved, or it will shut down if any of them is rejected. | -| [isSetupOnHold](./kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md) | () => boolean | Indicates whether Kibana is currently on hold and cannot proceed to setup yet. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md deleted file mode 100644 index 4ccc91fbe1f74..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PublicUiSettingsParams](./kibana-plugin-core-server.publicuisettingsparams.md) - -## PublicUiSettingsParams type - -A sub-set of [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) exposed to the client-side. - -Signature: - -```typescript -export declare type PublicUiSettingsParams = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md deleted file mode 100644 index cd5c326c1b9ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RedirectResponseOptions](./kibana-plugin-core-server.redirectresponseoptions.md) - -## RedirectResponseOptions type - -HTTP response parameters for redirection response - -Signature: - -```typescript -export declare type RedirectResponseOptions = HttpResponseOptions & { - headers: { - location: string; - }; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md b/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md deleted file mode 100644 index cf008725ff15b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) > [getDeprecations](./kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md) - -## RegisterDeprecationsConfig.getDeprecations property - -Signature: - -```typescript -getDeprecations: (context: GetDeprecationsContext) => MaybePromise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md b/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md deleted file mode 100644 index b7787a1406319..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) - -## RegisterDeprecationsConfig interface - - -Signature: - -```typescript -export interface RegisterDeprecationsConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getDeprecations](./kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md) | (context: GetDeprecationsContext) => MaybePromise<DeprecationsDetails\[\]> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md b/docs/development/core/server/kibana-plugin-core-server.requesthandler.md deleted file mode 100644 index 0ba0f72d7ab2f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandler](./kibana-plugin-core-server.requesthandler.md) - -## RequestHandler type - -A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) functions. If anything else is returned, or an error is thrown, the HTTP service will automatically log the error and respond `500 - Internal Server Error`. - -Signature: - -```typescript -export declare type RequestHandler

= (context: Context, request: KibanaRequest, response: ResponseFactory) => IKibanaResponse | Promise>; -``` - -## Example - - -```ts -const router = httpSetup.createRouter(); -// creates a route handler for GET request on 'my-app/path/{id}' path -router.get( - { - path: 'path/{id}', - // defines a validation schema for a named segment of the route path - validate: { - params: schema.object({ - id: schema.string(), - }), - }, - }, - // function to execute to create a responses - async (context, request, response) => { - const data = await context.findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) return response.notFound(); - // creates a command to send found data to the client - return response.ok(data); - } -); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md deleted file mode 100644 index 8d0b715fdef7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) > [core](./kibana-plugin-core-server.requesthandlercontext.core.md) - -## RequestHandlerContext.core property - -Signature: - -```typescript -core: Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md deleted file mode 100644 index 214f8a6f6ba5c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) - -## RequestHandlerContext interface - -Base context passed to a route handler. - -Signature: - -```typescript -export interface RequestHandlerContext extends RequestHandlerContextBase -``` -Extends: RequestHandlerContextBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | Promise<CoreRequestHandlerContext> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md deleted file mode 100644 index 33a123eefae63..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) - -## RequestHandlerContextBase interface - -\* - -Signature: - -```typescript -export interface RequestHandlerContextBase -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md) | <T extends keyof Omit<this, 'resolve'>>(parts: T\[\]) => Promise<AwaitedProperties<Pick<this, T>>> | Await all the specified context parts and return them. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md deleted file mode 100644 index 74192c0e1aee8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) > [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md) - -## RequestHandlerContextBase.resolve property - -Await all the specified context parts and return them. - -Signature: - -```typescript -resolve: >(parts: T[]) => Promise>>; -``` - -## Example - - -```ts -const resolved = await context.resolve(['core', 'pluginA']); -const esClient = resolved.core.elasticsearch.client; -const pluginAService = resolved.pluginA.someService; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md deleted file mode 100644 index 09e7ff261b795..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextContainer](./kibana-plugin-core-server.requesthandlercontextcontainer.md) - -## RequestHandlerContextContainer type - -An object that handles registration of http request context providers. - -Signature: - -```typescript -export declare type RequestHandlerContextContainer = IContextContainer; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md deleted file mode 100644 index d94facd849eff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextProvider](./kibana-plugin-core-server.requesthandlercontextprovider.md) - -## RequestHandlerContextProvider type - -Context provider for request handler. Extends request context object with provided functionality or data. - -Signature: - -```typescript -export declare type RequestHandlerContextProvider = IContextProvider; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md deleted file mode 100644 index 6ae585b4eeb04..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md) - -## RequestHandlerWrapper type - -Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function. - -Signature: - -```typescript -export declare type RequestHandlerWrapper = (handler: RequestHandler) => RequestHandler; -``` - -## Example - - -```typescript -export const wrapper: RequestHandlerWrapper = handler => { - return async (context, request, response) => { - // do some logic - ... - }; -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md b/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md deleted file mode 100644 index e23d07d7683de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) - -## ResolveCapabilitiesOptions interface - -Defines a set of additional options for the `resolveCapabilities` method of [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md). - -Signature: - -```typescript -export interface ResolveCapabilitiesOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [useDefaultCapabilities](./kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md) | boolean | Indicates if capability switchers are supposed to return a default set of capabilities. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md b/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md deleted file mode 100644 index 792893a3fc096..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) > [useDefaultCapabilities](./kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md) - -## ResolveCapabilitiesOptions.useDefaultCapabilities property - -Indicates if capability switchers are supposed to return a default set of capabilities. - -Signature: - -```typescript -useDefaultCapabilities: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseerror.md b/docs/development/core/server/kibana-plugin-core-server.responseerror.md deleted file mode 100644 index 2d37fa841f273..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseerror.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseError](./kibana-plugin-core-server.responseerror.md) - -## ResponseError type - -Error message and optional data send to the client in case of error. - -Signature: - -```typescript -export declare type ResponseError = string | Error | { - message: string | Error; - attributes?: ResponseErrorAttributes; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md b/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md deleted file mode 100644 index cc85b05f7154e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseErrorAttributes](./kibana-plugin-core-server.responseerrorattributes.md) - -## ResponseErrorAttributes type - -Additional data to provide error details. - -Signature: - -```typescript -export declare type ResponseErrorAttributes = Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md b/docs/development/core/server/kibana-plugin-core-server.responseheaders.md deleted file mode 100644 index fb7d6a10c6b6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseHeaders](./kibana-plugin-core-server.responseheaders.md) - -## ResponseHeaders type - -Http response headers to set. - -Signature: - -```typescript -export declare type ResponseHeaders = Record | Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.md deleted file mode 100644 index 6297e2745cd31..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) - -## RouteConfig interface - -Route specific configuration. - -Signature: - -```typescript -export interface RouteConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [options?](./kibana-plugin-core-server.routeconfig.options.md) | RouteConfigOptions<Method> | (Optional) Additional route options [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md). | -| [path](./kibana-plugin-core-server.routeconfig.path.md) | string | The endpoint \_within\_ the router path to register the route. | -| [validate](./kibana-plugin-core-server.routeconfig.validate.md) | RouteValidatorFullConfig<P, Q, B> \| false | A schema created with @kbn/config-schema that every request will be validated against. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md deleted file mode 100644 index 668e293e71827..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [options](./kibana-plugin-core-server.routeconfig.options.md) - -## RouteConfig.options property - -Additional route options [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md). - -Signature: - -```typescript -options?: RouteConfigOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md deleted file mode 100644 index 6d173322442a1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [path](./kibana-plugin-core-server.routeconfig.path.md) - -## RouteConfig.path property - -The endpoint \_within\_ the router path to register the route. - -Signature: - -```typescript -path: string; -``` - -## Remarks - -E.g. if the router is registered at `/elasticsearch` and the route path is `/search`, the full path for the route is `/elasticsearch/search`. Supports: - named path segments `path/{name}`. - optional path segments `path/{position?}`. - multi-segments `path/{coordinates*2}`. Segments are accessible within a handler function as `params` property of [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) object. To have read access to `params` you \*must\* specify validation schema with [RouteConfig.validate](./kibana-plugin-core-server.routeconfig.validate.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md deleted file mode 100644 index 1f9cc216cad35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [validate](./kibana-plugin-core-server.routeconfig.validate.md) - -## RouteConfig.validate property - -A schema created with `@kbn/config-schema` that every request will be validated against. - -Signature: - -```typescript -validate: RouteValidatorFullConfig | false; -``` - -## Remarks - -You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { unknowns: 'allow' })`; - -## Example - - -```ts - import { schema } from '@kbn/config-schema'; - router.get({ - path: 'path/{id}', - validate: { - params: schema.object({ - id: schema.string(), - }), - query: schema.object({...}), - body: schema.object({...}), - }, -}, -(context, req, res,) { - req.params; // type Readonly<{id: string}> - console.log(req.params.id); // value -}); - -router.get({ - path: 'path/{id}', - validate: false, // handler has no access to params, query, body values. -}, -(context, req, res,) { - req.params; // type Readonly<{}>; - console.log(req.params.id); // undefined -}); - -router.get({ - path: 'path/{id}', - validate: { - // handler has access to raw non-validated params in runtime - params: schema.object({}, { unknowns: 'allow' }) - }, -}, -(context, req, res,) { - req.params; // type Readonly<{}>; - console.log(req.params.id); // value - myValidationLibrary.validate({ params: req.params }); -}); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md deleted file mode 100644 index 28f712316bc36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [authRequired](./kibana-plugin-core-server.routeconfigoptions.authrequired.md) - -## RouteConfigOptions.authRequired property - -Defines authentication mode for a route: - true. A user has to have valid credentials to access a resource - false. A user can access a resource without any credentials. - 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. Can be useful when we grant access to a resource but want to identify a user if possible. - -Defaults to `true` if an auth mechanism is registered. - -Signature: - -```typescript -authRequired?: boolean | 'optional'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md deleted file mode 100644 index a243eb1d91d5b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [body](./kibana-plugin-core-server.routeconfigoptions.body.md) - -## RouteConfigOptions.body property - -Additional body options [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md). - -Signature: - -```typescript -body?: Method extends 'get' | 'options' ? undefined : RouteConfigOptionsBody; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md deleted file mode 100644 index 2dcd8ee5420ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) - -## RouteConfigOptions interface - -Additional route options. - -Signature: - -```typescript -export interface RouteConfigOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authRequired?](./kibana-plugin-core-server.routeconfigoptions.authrequired.md) | boolean \| 'optional' | (Optional) Defines authentication mode for a route: - true. A user has to have valid credentials to access a resource - false. A user can access a resource without any credentials. - 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. Can be useful when we grant access to a resource but want to identify a user if possible.Defaults to true if an auth mechanism is registered. | -| [body?](./kibana-plugin-core-server.routeconfigoptions.body.md) | Method extends 'get' \| 'options' ? undefined : RouteConfigOptionsBody | (Optional) Additional body options [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md). | -| [tags?](./kibana-plugin-core-server.routeconfigoptions.tags.md) | readonly string\[\] | (Optional) Additional metadata tag strings to attach to the route. | -| [timeout?](./kibana-plugin-core-server.routeconfigoptions.timeout.md) | { payload?: Method extends 'get' \| 'options' ? undefined : number; idleSocket?: number; } | (Optional) Defines per-route timeouts. | -| [xsrfRequired?](./kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md) | Method extends 'get' ? never : boolean | (Optional) Defines xsrf protection requirements for a route: - true. Requires an incoming POST/PUT/DELETE request to contain kbn-xsrf header. - false. Disables xsrf protection.Set to true by default | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md deleted file mode 100644 index f279a414d021f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [tags](./kibana-plugin-core-server.routeconfigoptions.tags.md) - -## RouteConfigOptions.tags property - -Additional metadata tag strings to attach to the route. - -Signature: - -```typescript -tags?: readonly string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md deleted file mode 100644 index f602a8913964f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [timeout](./kibana-plugin-core-server.routeconfigoptions.timeout.md) - -## RouteConfigOptions.timeout property - -Defines per-route timeouts. - -Signature: - -```typescript -timeout?: { - payload?: Method extends 'get' | 'options' ? undefined : number; - idleSocket?: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md deleted file mode 100644 index 1b6a43332e87f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [xsrfRequired](./kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md) - -## RouteConfigOptions.xsrfRequired property - -Defines xsrf protection requirements for a route: - true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header. - false. Disables xsrf protection. - -Set to true by default - -Signature: - -```typescript -xsrfRequired?: Method extends 'get' ? never : boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md deleted file mode 100644 index 1e98e33cec00f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [accepts](./kibana-plugin-core-server.routeconfigoptionsbody.accepts.md) - -## RouteConfigOptionsBody.accepts property - -A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed above will not enable them to be parsed, and if parse is true, the request will result in an error response. - -Default value: allows parsing of the following mime types: \* application/json \* application/\*+json \* application/octet-stream \* application/x-www-form-urlencoded \* multipart/form-data \* text/\* - -Signature: - -```typescript -accepts?: RouteContentType | RouteContentType[] | string | string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md deleted file mode 100644 index 4d2641255adb4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [maxBytes](./kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md) - -## RouteConfigOptionsBody.maxBytes property - -Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. - -Default value: The one set in the kibana.yml config file under the parameter `server.maxPayload`. - -Signature: - -```typescript -maxBytes?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md deleted file mode 100644 index fdae03f7cd7c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) - -## RouteConfigOptionsBody interface - -Additional body options for a route - -Signature: - -```typescript -export interface RouteConfigOptionsBody -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [accepts?](./kibana-plugin-core-server.routeconfigoptionsbody.accepts.md) | RouteContentType \| RouteContentType\[\] \| string \| string\[\] | (Optional) A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed above will not enable them to be parsed, and if parse is true, the request will result in an error response.Default value: allows parsing of the following mime types: \* application/json \* application/\*+json \* application/octet-stream \* application/x-www-form-urlencoded \* multipart/form-data \* text/\* | -| [maxBytes?](./kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md) | number | (Optional) Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.Default value: The one set in the kibana.yml config file under the parameter server.maxPayload. | -| [output?](./kibana-plugin-core-server.routeconfigoptionsbody.output.md) | typeof validBodyOutput\[number\] | (Optional) The processed payload format. The value must be one of: \* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw Buffer is returned. \* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the multipart payload in the handler using a streaming parser (e.g. pez).Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. | -| [parse?](./kibana-plugin-core-server.routeconfigoptionsbody.parse.md) | boolean \| 'gunzip' | (Optional) Determines if the incoming payload is processed or presented raw. Available values: \* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. \* false - the raw payload is returned unmodified. \* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md deleted file mode 100644 index a7d712a39e808..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [output](./kibana-plugin-core-server.routeconfigoptionsbody.output.md) - -## RouteConfigOptionsBody.output property - -The processed payload format. The value must be one of: \* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw Buffer is returned. \* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the multipart payload in the handler using a streaming parser (e.g. pez). - -Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. - -Signature: - -```typescript -output?: typeof validBodyOutput[number]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md deleted file mode 100644 index 80c8d470598e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [parse](./kibana-plugin-core-server.routeconfigoptionsbody.parse.md) - -## RouteConfigOptionsBody.parse property - -Determines if the incoming payload is processed or presented raw. Available values: \* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. \* false - the raw payload is returned unmodified. \* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. - -Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. - -Signature: - -```typescript -parse?: boolean | 'gunzip'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md b/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md deleted file mode 100644 index 8d8b041f3c722..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteContentType](./kibana-plugin-core-server.routecontenttype.md) - -## RouteContentType type - -The set of supported parseable Content-Types - -Signature: - -```typescript -export declare type RouteContentType = 'application/json' | 'application/*+json' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/*'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routemethod.md b/docs/development/core/server/kibana-plugin-core-server.routemethod.md deleted file mode 100644 index 297ed5ce25cee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteMethod](./kibana-plugin-core-server.routemethod.md) - -## RouteMethod type - -The set of common HTTP methods supported by Kibana routing. - -Signature: - -```typescript -export declare type RouteMethod = SafeRouteMethod | DestructiveRouteMethod; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md b/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md deleted file mode 100644 index 3ddb350a38b6f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteRegistrar](./kibana-plugin-core-server.routeregistrar.md) - -## RouteRegistrar type - -Route handler common definition - -Signature: - -```typescript -export declare type RouteRegistrar = (route: RouteConfig, handler: RequestHandler) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md deleted file mode 100644 index ad1a4bae0dab1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) > [(constructor)](./kibana-plugin-core-server.routevalidationerror._constructor_.md) - -## RouteValidationError.(constructor) - -Constructs a new instance of the `RouteValidationError` class - -Signature: - -```typescript -constructor(error: Error | string, path?: string[]); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| string | | -| path | string\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md deleted file mode 100644 index 60a47236b4be5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) - -## RouteValidationError class - -Error to return when the validation is not successful. - -Signature: - -```typescript -export declare class RouteValidationError extends SchemaTypeError -``` -Extends: SchemaTypeError - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(error, path)](./kibana-plugin-core-server.routevalidationerror._constructor_.md) | | Constructs a new instance of the RouteValidationError class | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md deleted file mode 100644 index e3fd33552f7df..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) - -## RouteValidationFunction type - -The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. - -Signature: - -```typescript -export declare type RouteValidationFunction = (data: any, validationResult: RouteValidationResultFactory) => { - value: T; - error?: never; -} | { - value?: never; - error: RouteValidationError; -}; -``` - -## Example - -The validation should look something like: - -```typescript -interface MyExpectedBody { - bar: string; - baz: number; -} - -const myBodyValidation: RouteValidationFunction = (data, validationResult) => { - const { ok, badRequest } = validationResult; - const { bar, baz } = data || {}; - if (typeof bar === 'string' && typeof baz === 'number') { - return ok({ bar, baz }); - } else { - return badRequest('Wrong payload', ['body']); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md deleted file mode 100644 index d02ce47a84d50..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) > [badRequest](./kibana-plugin-core-server.routevalidationresultfactory.badrequest.md) - -## RouteValidationResultFactory.badRequest property - -Signature: - -```typescript -badRequest: (error: Error | string, path?: string[]) => { - error: RouteValidationError; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md deleted file mode 100644 index 69e8b5e73136e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) - -## RouteValidationResultFactory interface - -Validation result factory to be used in the custom validation function to return the valid data or validation errors - -See [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md). - -Signature: - -```typescript -export interface RouteValidationResultFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [badRequest](./kibana-plugin-core-server.routevalidationresultfactory.badrequest.md) | (error: Error \| string, path?: string\[\]) => { error: RouteValidationError; } | | -| [ok](./kibana-plugin-core-server.routevalidationresultfactory.ok.md) | <T>(value: T) => { value: T; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md deleted file mode 100644 index 42e7a055cd021..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) > [ok](./kibana-plugin-core-server.routevalidationresultfactory.ok.md) - -## RouteValidationResultFactory.ok property - -Signature: - -```typescript -ok: (value: T) => { - value: T; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md deleted file mode 100644 index 193e047efcfe0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationSpec](./kibana-plugin-core-server.routevalidationspec.md) - -## RouteValidationSpec type - -Allowed property validation options: either @kbn/config-schema validations or custom validation functions - -See [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) for custom validation. - -Signature: - -```typescript -export declare type RouteValidationSpec = ObjectType | Type | RouteValidationFunction; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md deleted file mode 100644 index 922a475b432fa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [body](./kibana-plugin-core-server.routevalidatorconfig.body.md) - -## RouteValidatorConfig.body property - -Validation logic for the body payload - -Signature: - -```typescript -body?: RouteValidationSpec; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md deleted file mode 100644 index 848bf6aa4b15e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) - -## RouteValidatorConfig interface - -The configuration object to the RouteValidator class. Set `params`, `query` and/or `body` to specify the validation logic to follow for that property. - -Signature: - -```typescript -export interface RouteValidatorConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.routevalidatorconfig.body.md) | RouteValidationSpec<B> | (Optional) Validation logic for the body payload | -| [params?](./kibana-plugin-core-server.routevalidatorconfig.params.md) | RouteValidationSpec<P> | (Optional) Validation logic for the URL params | -| [query?](./kibana-plugin-core-server.routevalidatorconfig.query.md) | RouteValidationSpec<Q> | (Optional) Validation logic for the Query params | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md deleted file mode 100644 index 1281d4ab78f6f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [params](./kibana-plugin-core-server.routevalidatorconfig.params.md) - -## RouteValidatorConfig.params property - -Validation logic for the URL params - -Signature: - -```typescript -params?: RouteValidationSpec

; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md deleted file mode 100644 index 9bda00954c02f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [query](./kibana-plugin-core-server.routevalidatorconfig.query.md) - -## RouteValidatorConfig.query property - -Validation logic for the Query params - -Signature: - -```typescript -query?: RouteValidationSpec; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md deleted file mode 100644 index 4ed91aee6b8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorFullConfig](./kibana-plugin-core-server.routevalidatorfullconfig.md) - -## RouteValidatorFullConfig type - -Route validations config and options merged into one object - -Signature: - -```typescript -export declare type RouteValidatorFullConfig = RouteValidatorConfig & RouteValidatorOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md deleted file mode 100644 index f054ca388762a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) - -## RouteValidatorOptions interface - -Additional options for the RouteValidator class to modify its default behaviour. - -Signature: - -```typescript -export interface RouteValidatorOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [unsafe?](./kibana-plugin-core-server.routevalidatoroptions.unsafe.md) | { params?: boolean; query?: boolean; body?: boolean; } | (Optional) Set the unsafe config to avoid running some additional internal \*safe\* validations on top of your custom validation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md deleted file mode 100644 index ca66ccbb55a36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) > [unsafe](./kibana-plugin-core-server.routevalidatoroptions.unsafe.md) - -## RouteValidatorOptions.unsafe property - -Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation - -Signature: - -```typescript -unsafe?: { - params?: boolean; - query?: boolean; - body?: boolean; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md b/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md deleted file mode 100644 index 93a8d8de358be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SafeRouteMethod](./kibana-plugin-core-server.saferoutemethod.md) - -## SafeRouteMethod type - -Set of HTTP methods not changing the state of the server. - -Signature: - -```typescript -export declare type SafeRouteMethod = 'get' | 'options'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md deleted file mode 100644 index 3bc0900bb4005..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [attributes](./kibana-plugin-core-server.savedobject.attributes.md) - -## SavedObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md deleted file mode 100644 index b4d1f3c769451..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobject.coremigrationversion.md) - -## SavedObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md deleted file mode 100644 index ef42053e38626..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [error](./kibana-plugin-core-server.savedobject.error.md) - -## SavedObject.error property - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md deleted file mode 100644 index 86adacdc4c41a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [id](./kibana-plugin-core-server.savedobject.id.md) - -## SavedObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.md deleted file mode 100644 index cffb47659dc23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) - -## SavedObject interface - -Signature: - -```typescript -export interface SavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobject.attributes.md) | T | The data for a Saved Object is stored as an object in the attributes property. | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [error?](./kibana-plugin-core-server.savedobject.error.md) | SavedObjectError | (Optional) | -| [id](./kibana-plugin-core-server.savedobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [migrationVersion?](./kibana-plugin-core-server.savedobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [namespaces?](./kibana-plugin-core-server.savedobject.namespaces.md) | string\[\] | (Optional) Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [originId?](./kibana-plugin-core-server.savedobject.originid.md) | string | (Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. | -| [references](./kibana-plugin-core-server.savedobject.references.md) | SavedObjectReference\[\] | A reference to another saved object. | -| [type](./kibana-plugin-core-server.savedobject.type.md) | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. | -| [updated\_at?](./kibana-plugin-core-server.savedobject.updated_at.md) | string | (Optional) Timestamp of the last time this document had been updated. | -| [version?](./kibana-plugin-core-server.savedobject.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md deleted file mode 100644 index 3b3eaa6e5da06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [migrationVersion](./kibana-plugin-core-server.savedobject.migrationversion.md) - -## SavedObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md deleted file mode 100644 index 3c2909486219b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [namespaces](./kibana-plugin-core-server.savedobject.namespaces.md) - -## SavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md deleted file mode 100644 index 95bcad7ce8b1b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [originId](./kibana-plugin-core-server.savedobject.originid.md) - -## SavedObject.originId property - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md deleted file mode 100644 index f8290bd40d217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [references](./kibana-plugin-core-server.savedobject.references.md) - -## SavedObject.references property - -A reference to another saved object. - -Signature: - -```typescript -references: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md deleted file mode 100644 index 6c667b0b9c3a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [type](./kibana-plugin-core-server.savedobject.type.md) - -## SavedObject.type property - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md deleted file mode 100644 index a9585761ca808..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [updated\_at](./kibana-plugin-core-server.savedobject.updated_at.md) - -## SavedObject.updated\_at property - -Timestamp of the last time this document had been updated. - -Signature: - -```typescript -updated_at?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md deleted file mode 100644 index ef8fd3be86beb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [version](./kibana-plugin-core-server.savedobject.version.md) - -## SavedObject.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md deleted file mode 100644 index 1a1e3f62d34f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) - -## SavedObjectAttribute type - -Type definition for a Saved Object attribute value - -Signature: - -```typescript -export declare type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md deleted file mode 100644 index 2b8b212cd78d6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttributes](./kibana-plugin-core-server.savedobjectattributes.md) - -## SavedObjectAttributes interface - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -export interface SavedObjectAttributes -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md deleted file mode 100644 index 7c84fa5414074..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttributeSingle](./kibana-plugin-core-server.savedobjectattributesingle.md) - -## SavedObjectAttributeSingle type - -Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) - -Signature: - -```typescript -export declare type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md deleted file mode 100644 index 0972d82987f51..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [excludeExportDetails](./kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md) - -## SavedObjectExportBaseOptions.excludeExportDetails property - -flag to not append [export details](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) to the end of the export stream. - -Signature: - -```typescript -excludeExportDetails?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md deleted file mode 100644 index 8ac532c601efc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [includeNamespaces](./kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md) - -## SavedObjectExportBaseOptions.includeNamespaces property - -Flag to also include namespace information in the export stream. By default, namespace information is not included in exported objects. This is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP route for exports. - -Signature: - -```typescript -includeNamespaces?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md deleted file mode 100644 index 6a7c86c1af860..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [includeReferencesDeep](./kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md) - -## SavedObjectExportBaseOptions.includeReferencesDeep property - -flag to also include all related saved objects in the export stream. - -Signature: - -```typescript -includeReferencesDeep?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md deleted file mode 100644 index d2749cb85cd3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) - -## SavedObjectExportBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectExportBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludeExportDetails?](./kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md) | boolean | (Optional) flag to not append [export details](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) to the end of the export stream. | -| [includeNamespaces?](./kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md) | boolean | (Optional) Flag to also include namespace information in the export stream. By default, namespace information is not included in exported objects. This is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP route for exports. | -| [includeReferencesDeep?](./kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md) | boolean | (Optional) flag to also include all related saved objects in the export stream. | -| [namespace?](./kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md) | string | (Optional) optional namespace to override the namespace used by the savedObjectsClient. | -| [request](./kibana-plugin-core-server.savedobjectexportbaseoptions.request.md) | KibanaRequest | The http request initiating the export. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md deleted file mode 100644 index 9a8dad24ac18e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md) - -## SavedObjectExportBaseOptions.namespace property - -optional namespace to override the namespace used by the savedObjectsClient. - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md deleted file mode 100644 index d425f9b88e818..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [request](./kibana-plugin-core-server.savedobjectexportbaseoptions.request.md) - -## SavedObjectExportBaseOptions.request property - -The http request initiating the export. - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md deleted file mode 100644 index 9fe43a2f3f477..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [convertToMultiNamespaceTypeVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md) - -## SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion property - -The version in which this object type is being converted to a multi-namespace type - -Signature: - -```typescript -readonly convertToMultiNamespaceTypeVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md deleted file mode 100644 index 528be67f029c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [isSingleNamespaceType](./kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md) - -## SavedObjectMigrationContext.isSingleNamespaceType property - -Whether this is a single-namespace type or not - -Signature: - -```typescript -readonly isSingleNamespaceType: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md deleted file mode 100644 index 20a0e99275a39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [log](./kibana-plugin-core-server.savedobjectmigrationcontext.log.md) - -## SavedObjectMigrationContext.log property - -logger instance to be used by the migration handler - -Signature: - -```typescript -readonly log: SavedObjectsMigrationLogger; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md deleted file mode 100644 index 3a265cc8e1d42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) - -## SavedObjectMigrationContext interface - -Migration context provided when invoking a [migration handler](./kibana-plugin-core-server.savedobjectmigrationfn.md) - -Signature: - -```typescript -export interface SavedObjectMigrationContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [convertToMultiNamespaceTypeVersion?](./kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md) | string | (Optional) The version in which this object type is being converted to a multi-namespace type | -| [isSingleNamespaceType](./kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md) | boolean | Whether this is a single-namespace type or not | -| [log](./kibana-plugin-core-server.savedobjectmigrationcontext.log.md) | SavedObjectsMigrationLogger | logger instance to be used by the migration handler | -| [migrationVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md) | string | The migration version that this migration function is defined for | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md deleted file mode 100644 index a1c2717e6e4a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md) - -## SavedObjectMigrationContext.migrationVersion property - -The migration version that this migration function is defined for - -Signature: - -```typescript -readonly migrationVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md deleted file mode 100644 index 1c96c63a3d4fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationFn](./kibana-plugin-core-server.savedobjectmigrationfn.md) - -## SavedObjectMigrationFn type - -A migration function for a [saved object type](./kibana-plugin-core-server.savedobjectstype.md) used to migrate it to a given version - -Signature: - -```typescript -export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc; -``` - -## Example - - -```typescript -interface TypeV1Attributes { - someKey: string; - obsoleteProperty: number; -} - -interface TypeV2Attributes { - someKey: string; - newProperty: string; -} - -const migrateToV2: SavedObjectMigrationFn = (doc, { log }) => { - const { obsoleteProperty, ...otherAttributes } = doc.attributes; - // instead of mutating `doc` we make a shallow copy so that we can use separate types for the input - // and output attributes. We don't need to make a deep copy, we just need to ensure that obsolete - // attributes are not present on the returned doc. - return { - ...doc, - attributes: { - ...otherAttributes, - newProperty: migrate(obsoleteProperty), - }, - }; -}; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md deleted file mode 100644 index 64575d34bfb10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationMap](./kibana-plugin-core-server.savedobjectmigrationmap.md) - -## SavedObjectMigrationMap interface - -A map of [migration functions](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions, and they cannot exceed the current Kibana version. - -For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. - -Signature: - -```typescript -export interface SavedObjectMigrationMap -``` - -## Example - - -```typescript -const migrationsMap: SavedObjectMigrationMap = { - '1.0.0': migrateToV1, - '2.1.0': migrateToV21 -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md deleted file mode 100644 index f5f1de451165b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [id](./kibana-plugin-core-server.savedobjectreference.id.md) - -## SavedObjectReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md deleted file mode 100644 index bf21b13acfcfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) - -## SavedObjectReference interface - -A reference to another saved object. - -Signature: - -```typescript -export interface SavedObjectReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectreference.id.md) | string | | -| [name](./kibana-plugin-core-server.savedobjectreference.name.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectreference.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md deleted file mode 100644 index 782e8060a31f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [name](./kibana-plugin-core-server.savedobjectreference.name.md) - -## SavedObjectReference.name property - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md deleted file mode 100644 index 045a540904279..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [type](./kibana-plugin-core-server.savedobjectreference.type.md) - -## SavedObjectReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md deleted file mode 100644 index 7ef1a2fb1bd41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [id](./kibana-plugin-core-server.savedobjectreferencewithcontext.id.md) - -## SavedObjectReferenceWithContext.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md deleted file mode 100644 index 058c27032d065..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [inboundReferences](./kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md) - -## SavedObjectReferenceWithContext.inboundReferences property - -References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation - -Signature: - -```typescript -inboundReferences: Array<{ - type: string; - id: string; - name: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md deleted file mode 100644 index d46d5a6bf2a0a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [isMissing](./kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md) - -## SavedObjectReferenceWithContext.isMissing property - -Whether or not this object or reference is missing - -Signature: - -```typescript -isMissing?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md deleted file mode 100644 index 79dd7a40019ec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) - -## SavedObjectReferenceWithContext interface - -A returned input object or one of its references, with additional context. - -Signature: - -```typescript -export interface SavedObjectReferenceWithContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectreferencewithcontext.id.md) | string | The ID of the referenced object | -| [inboundReferences](./kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md) | Array<{ type: string; id: string; name: string; }> | References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation | -| [isMissing?](./kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md) | boolean | (Optional) Whether or not this object or reference is missing | -| [originId?](./kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md) | string | (Optional) The origin ID of the referenced object (if it has one) | -| [spaces](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [spacesWithMatchingAliases?](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) | string\[\] | (Optional) The space(s) that legacy URL aliases matching this type/id exist in | -| [spacesWithMatchingOrigins?](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) | string\[\] | (Optional) The space(s) that objects matching this origin exist in (including this one) | -| [type](./kibana-plugin-core-server.savedobjectreferencewithcontext.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md deleted file mode 100644 index 47cac3f423647..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [originId](./kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md) - -## SavedObjectReferenceWithContext.originId property - -The origin ID of the referenced object (if it has one) - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md deleted file mode 100644 index 2c2114103b29a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spaces](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md) - -## SavedObjectReferenceWithContext.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md deleted file mode 100644 index 07f4158a84950..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spacesWithMatchingAliases](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingAliases property - -The space(s) that legacy URL aliases matching this type/id exist in - -Signature: - -```typescript -spacesWithMatchingAliases?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md deleted file mode 100644 index 3fedce753c034..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spacesWithMatchingOrigins](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingOrigins property - -The space(s) that objects matching this origin exist in (including this one) - -Signature: - -```typescript -spacesWithMatchingOrigins?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md deleted file mode 100644 index 118d9744e4276..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [type](./kibana-plugin-core-server.savedobjectreferencewithcontext.type.md) - -## SavedObjectReferenceWithContext.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md deleted file mode 100644 index 3f4090619edbf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectSanitizedDoc](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) - -## SavedObjectSanitizedDoc type - -Describes Saved Object documents that have passed through the migration framework and are guaranteed to have a `references` root property. - -Signature: - -```typescript -export declare type SavedObjectSanitizedDoc = SavedObjectDoc & Referencable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md deleted file mode 100644 index 6686ad7ca8bad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) - -## SavedObjectsBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md) | string | (Optional) Specify the namespace for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md deleted file mode 100644 index 7468327233d4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md) - -## SavedObjectsBaseOptions.namespace property - -Specify the namespace for this operation - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md deleted file mode 100644 index c74a058ca441b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [attributes](./kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md) - -## SavedObjectsBulkCreateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md deleted file mode 100644 index fb1f485cdf202..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md) - -## SavedObjectsBulkCreateObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` - -## Remarks - -Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` field set and you want to create it again. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md deleted file mode 100644 index 13f64c70d39fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md) - -## SavedObjectsBulkCreateObject.id property - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md deleted file mode 100644 index 4d094ecde7a96..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [initialNamespaces](./kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md) - -## SavedObjectsBulkCreateObject.initialNamespaces property - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md). - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -initialNamespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md deleted file mode 100644 index 441df5d50c612..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) - -## SavedObjectsBulkCreateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkCreateObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md) | T | | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. | -| [id?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md) | string | (Optional) | -| [initialNamespaces?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md) | string\[\] | (Optional) Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md).\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [originId?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md) | string | (Optional) Optional ID of the original saved object, if this object's id was regenerated | -| [references?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md) | SavedObjectReference\[\] | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md) | string | | -| [version?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md) | string | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md deleted file mode 100644 index a2d8de7c5caaa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md) - -## SavedObjectsBulkCreateObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md deleted file mode 100644 index c182a47891f62..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [originId](./kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md) - -## SavedObjectsBulkCreateObject.originId property - -Optional ID of the original saved object, if this object's `id` was regenerated - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md deleted file mode 100644 index d5aed38d7c1e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [references](./kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md) - -## SavedObjectsBulkCreateObject.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md deleted file mode 100644 index 0d9973ec78b4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md) - -## SavedObjectsBulkCreateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md deleted file mode 100644 index ca2a38693d036..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [version](./kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md) - -## SavedObjectsBulkCreateObject.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md deleted file mode 100644 index d20f79101e13d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [fields](./kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md) - -## SavedObjectsBulkGetObject.fields property - -SavedObject fields to include in the response - -Signature: - -```typescript -fields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md deleted file mode 100644 index c9d6b0527bd56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkgetobject.id.md) - -## SavedObjectsBulkGetObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md deleted file mode 100644 index 0eb5b507a1f03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) - -## SavedObjectsBulkGetObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkGetObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fields?](./kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md) | string\[\] | (Optional) SavedObject fields to include in the response | -| [id](./kibana-plugin-core-server.savedobjectsbulkgetobject.id.md) | string | | -| [namespaces?](./kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md) | string\[\] | (Optional) Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the top-level options.\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [type](./kibana-plugin-core-server.savedobjectsbulkgetobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md deleted file mode 100644 index 5add0ad1bdf95..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [namespaces](./kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md) - -## SavedObjectsBulkGetObject.namespaces property - -Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the top-level options. - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md deleted file mode 100644 index 9b78423da9d0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkgetobject.type.md) - -## SavedObjectsBulkGetObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md deleted file mode 100644 index 135848191cff7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md) - -## SavedObjectsBulkResolveObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md deleted file mode 100644 index a81e18cf3593a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) - -## SavedObjectsBulkResolveObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md deleted file mode 100644 index 790edde7fe079..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md) - -## SavedObjectsBulkResolveObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md deleted file mode 100644 index e280877d77cd6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) - -## SavedObjectsBulkResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolved\_objects](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md) | Array<SavedObjectsResolveResponse<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md deleted file mode 100644 index 4d11b146fd848..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md) - -## SavedObjectsBulkResolveResponse.resolved\_objects property - -Signature: - -```typescript -resolved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md deleted file mode 100644 index e47350e4bf888..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) - -## SavedObjectsBulkResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md) | Array<SavedObject<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md deleted file mode 100644 index 3b21276ec2a66..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md) - -## SavedObjectsBulkResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md deleted file mode 100644 index 7b8d41c4345af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) - -## SavedObjectsBulkUpdateObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md deleted file mode 100644 index 41aa239bbd502..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) - -## SavedObjectsBulkUpdateObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md deleted file mode 100644 index fa20d5d13d8f2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) - -## SavedObjectsBulkUpdateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateObject extends Pick, 'version' | 'references'> -``` -Extends: Pick<SavedObjectsUpdateOptions<T>, 'version' \| 'references'> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) | Partial<T> | The data for a Saved Object is stored as an object in the attributes property. | -| [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [namespace?](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | string | (Optional) Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md).Note: the default namespace's string representation is 'default', and its ID representation is undefined. | -| [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) | string | The type of this Saved Object. Each plugin can define it's own custom Saved Object types. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md deleted file mode 100644 index 544efcd3be909..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) - -## SavedObjectsBulkUpdateObject.namespace property - -Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md). - -Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md deleted file mode 100644 index f13adddc05a09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) - -## SavedObjectsBulkUpdateObject.type property - -The type of this Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md deleted file mode 100644 index 97285b326dbae..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) - -## SavedObjectsBulkUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md deleted file mode 100644 index 9c1b2145dd0da..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md) - -## SavedObjectsBulkUpdateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md deleted file mode 100644 index e1a1af2da25cc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) - -## SavedObjectsBulkUpdateResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md) | Array<SavedObjectsUpdateResponse<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md deleted file mode 100644 index e7cbad9678ca7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md) - -## SavedObjectsBulkUpdateResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md deleted file mode 100644 index 2b7cd5cc486a8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) > [id](./kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md) - -## SavedObjectsCheckConflictsObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md deleted file mode 100644 index af7d9ff74db25..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) - -## SavedObjectsCheckConflictsObject interface - - -Signature: - -```typescript -export interface SavedObjectsCheckConflictsObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md deleted file mode 100644 index 82f89536e4189..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) > [type](./kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md) - -## SavedObjectsCheckConflictsObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md deleted file mode 100644 index 80bd61d8906e3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) > [errors](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md) - -## SavedObjectsCheckConflictsResponse.errors property - -Signature: - -```typescript -errors: Array<{ - id: string; - type: string; - error: SavedObjectError; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md deleted file mode 100644 index 68bbdbe67c273..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) - -## SavedObjectsCheckConflictsResponse interface - - -Signature: - -```typescript -export interface SavedObjectsCheckConflictsResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md) | Array<{ id: string; type: string; error: SavedObjectError; }> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md deleted file mode 100644 index a88d82ef49e7d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkCreate](./kibana-plugin-core-server.savedobjectsclient.bulkcreate.md) - -## SavedObjectsClient.bulkCreate() method - -Persists multiple documents batched together as a single request - -Signature: - -```typescript -bulkCreate(objects: Array>, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkCreateObject<T>> | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md deleted file mode 100644 index 077cb08843acc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkGet](./kibana-plugin-core-server.savedobjectsclient.bulkget.md) - -## SavedObjectsClient.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkGetObject\[\] | an array of ids, or an array of objects containing id, type and optionally fields | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md deleted file mode 100644 index 3cf6e4d8d76a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkResolve](./kibana-plugin-core-server.savedobjectsclient.bulkresolve.md) - -## SavedObjectsClient.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: SavedObjectsBulkResolveObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkResolveObject\[\] | an array of objects containing id, type | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior is unique to `bulkResolve`; the regular `resolve` API will throw an error instead. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md deleted file mode 100644 index 6c4034357a4ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkUpdate](./kibana-plugin-core-server.savedobjectsclient.bulkupdate.md) - -## SavedObjectsClient.bulkUpdate() method - -Bulk Updates multiple SavedObject at once - -Signature: - -```typescript -bulkUpdate(objects: Array>, options?: SavedObjectsBulkUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkUpdateObject<T>> | | -| options | SavedObjectsBulkUpdateOptions | | - -Returns: - -Promise<SavedObjectsBulkUpdateResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md deleted file mode 100644 index 69d52ee098a30..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [checkConflicts](./kibana-plugin-core-server.savedobjectsclient.checkconflicts.md) - -## SavedObjectsClient.checkConflicts() method - -Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. - -Signature: - -```typescript -checkConflicts(objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCheckConflictsObject\[\] | | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsCheckConflictsResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md deleted file mode 100644 index beb5ea847bf45..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [closePointInTime](./kibana-plugin-core-server.savedobjectsclient.closepointintime.md) - -## SavedObjectsClient.closePointInTime() method - -Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. - -Signature: - -```typescript -closePointInTime(id: string, options?: SavedObjectsClosePointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | -| options | SavedObjectsClosePointInTimeOptions | | - -Returns: - -Promise<SavedObjectsClosePointInTimeResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md deleted file mode 100644 index 64ccd4187597c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [collectMultiNamespaceReferences](./kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md) - -## SavedObjectsClient.collectMultiNamespaceReferences() method - -Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. - -Signature: - -```typescript -collectMultiNamespaceReferences(objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCollectMultiNamespaceReferencesObject\[\] | | -| options | SavedObjectsCollectMultiNamespaceReferencesOptions | | - -Returns: - -Promise<SavedObjectsCollectMultiNamespaceReferencesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md deleted file mode 100644 index 9f9b72984bbb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [create](./kibana-plugin-core-server.savedobjectsclient.create.md) - -## SavedObjectsClient.create() method - -Persists a SavedObject - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SavedObject<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md deleted file mode 100644 index eab4312b1daa4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [createPointInTimeFinder](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) - -## SavedObjectsClient.createPointInTimeFinder() method - -Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any `find` queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client. - -Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments. - -The generator wraps calls to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage`. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -createPointInTimeFinder(findOptions: SavedObjectsCreatePointInTimeFinderOptions, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies): ISavedObjectsPointInTimeFinder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| findOptions | SavedObjectsCreatePointInTimeFinderOptions | | -| dependencies | SavedObjectsCreatePointInTimeFinderDependencies | | - -Returns: - -ISavedObjectsPointInTimeFinder<T, A> - -## Example - - -```ts -const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - type: 'visualization', - search: 'foo*', - perPage: 100, -}; - -const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - -const responses: SavedObjectFindResponse[] = []; -for await (const response of finder.find()) { - responses.push(...response); - if (doneSearching) { - await finder.close(); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md deleted file mode 100644 index 64ed7778d3bec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [delete](./kibana-plugin-core-server.savedobjectsclient.delete.md) - -## SavedObjectsClient.delete() method - -Deletes a SavedObject - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | | - -Returns: - -Promise<{}> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md deleted file mode 100644 index 79219f48d0501..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) - -## SavedObjectsClient.errors property - -Signature: - -```typescript -static errors: typeof SavedObjectsErrorHelpers; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md deleted file mode 100644 index dc48f7481dc01..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [find](./kibana-plugin-core-server.savedobjectsclient.find.md) - -## SavedObjectsClient.find() method - -Find all SavedObjects matching the search query - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | | - -Returns: - -Promise<SavedObjectsFindResponse<T, A>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md deleted file mode 100644 index 00b6dd28bb7aa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [get](./kibana-plugin-core-server.savedobjectsclient.get.md) - -## SavedObjectsClient.get() method - -Retrieves a single object - -Signature: - -```typescript -get(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of SavedObject to retrieve | -| id | string | The ID of the SavedObject to retrieve | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObject<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md deleted file mode 100644 index c77bcfac2f0e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) - -## SavedObjectsClient class - -Signature: - -```typescript -export declare class SavedObjectsClient -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) | | typeof SavedObjectsErrorHelpers | | -| [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) | static | typeof SavedObjectsErrorHelpers | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkcreate.md) | | Persists multiple documents batched together as a single request | -| [bulkGet(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkget.md) | | Returns an array of objects by id | -| [bulkResolve(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkresolve.md) | | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkupdate.md) | | Bulk Updates multiple SavedObject at once | -| [checkConflicts(objects, options)](./kibana-plugin-core-server.savedobjectsclient.checkconflicts.md) | | Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. | -| [closePointInTime(id, options)](./kibana-plugin-core-server.savedobjectsclient.closepointintime.md) | | Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md).Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. | -| [collectMultiNamespaceReferences(objects, options)](./kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md) | | Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. | -| [create(type, attributes, options)](./kibana-plugin-core-server.savedobjectsclient.create.md) | | Persists a SavedObject | -| [createPointInTimeFinder(findOptions, dependencies)](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) | | Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any find queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client.Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments.The generator wraps calls to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [delete(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.delete.md) | | Deletes a SavedObject | -| [find(options)](./kibana-plugin-core-server.savedobjectsclient.find.md) | | Find all SavedObjects matching the search query | -| [get(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.get.md) | | Retrieves a single object | -| [openPointInTimeForType(type, options)](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md) | | Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned id can then be passed to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) to search against that PIT.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. | -| [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md) | | Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. | -| [resolve(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.resolve.md) | | Resolves a single object, using any legacy URL alias if it exists | -| [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsclient.update.md) | | Updates an SavedObject | -| [updateObjectsSpaces(objects, spacesToAdd, spacesToRemove, options)](./kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md) | | Updates one or more objects to add and/or remove them from specified spaces. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md deleted file mode 100644 index c449fc7b1c3f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [openPointInTimeForType](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md) - -## SavedObjectsClient.openPointInTimeForType() method - -Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned `id` can then be passed to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) to search against that PIT. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. - -Signature: - -```typescript -openPointInTimeForType(type: string | string[], options?: SavedObjectsOpenPointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| string\[\] | | -| options | SavedObjectsOpenPointInTimeOptions | | - -Returns: - -Promise<SavedObjectsOpenPointInTimeResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md deleted file mode 100644 index 560c210b0105b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [removeReferencesTo](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md) - -## SavedObjectsClient.removeReferencesTo() method - -Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - -Signature: - -```typescript -removeReferencesTo(type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsRemoveReferencesToOptions | | - -Returns: - -Promise<SavedObjectsRemoveReferencesToResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md deleted file mode 100644 index 31eabe46d6cb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [resolve](./kibana-plugin-core-server.savedobjectsclient.resolve.md) - -## SavedObjectsClient.resolve() method - -Resolves a single object, using any legacy URL alias if it exists - -Signature: - -```typescript -resolve(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of SavedObject to retrieve | -| id | string | The ID of the SavedObject to retrieve | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsResolveResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md deleted file mode 100644 index 20a67387813ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [update](./kibana-plugin-core-server.savedobjectsclient.update.md) - -## SavedObjectsClient.update() method - -Updates an SavedObject - -Signature: - -```typescript -update(type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | Partial<T> | | -| options | SavedObjectsUpdateOptions<T> | | - -Returns: - -Promise<SavedObjectsUpdateResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md deleted file mode 100644 index 09012607fd932..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [updateObjectsSpaces](./kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md) - -## SavedObjectsClient.updateObjectsSpaces() method - -Updates one or more objects to add and/or remove them from specified spaces. - -Signature: - -```typescript -updateObjectsSpaces(objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsUpdateObjectsSpacesObject\[\] | | -| spacesToAdd | string\[\] | | -| spacesToRemove | string\[\] | | -| options | SavedObjectsUpdateObjectsSpacesOptions | | - -Returns: - -Promise<import("./lib").SavedObjectsUpdateObjectsSpacesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md deleted file mode 100644 index f4e7895a3f3eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) - -## SavedObjectsClientContract type - -Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. - -\#\# SavedObjectsClient errors - -Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either: - -1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the `isXYZError()` helpers exposed at `SavedObjectsErrorHelpers` should be used to understand and manage error responses from the `SavedObjectsClient`. - -Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for `error.body.error.type` or doing substring checks on `error.body.error.reason`, just use the helpers to understand the meaning of the error: - -\`\`\`js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 } - -if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know } - -// always rethrow the error unless you handle it throw error; \`\`\` - -\#\#\# 404s from missing index - -From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistence and that index might be missing. - -At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages. - -From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing. - -See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -Signature: - -```typescript -export declare type SavedObjectsClientContract = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md deleted file mode 100644 index 724c1ebbeadf4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md) - -## SavedObjectsClientFactory type - -Describes the factory used to create instances of the Saved Objects Client. - -Signature: - -```typescript -export declare type SavedObjectsClientFactory = ({ request, includedHiddenTypes, }: { - request: KibanaRequest; - includedHiddenTypes?: string[]; -}) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md deleted file mode 100644 index 0b7afda66408f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) - -## SavedObjectsClientFactoryProvider type - -Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md). - -Signature: - -```typescript -export declare type SavedObjectsClientFactoryProvider = (repositoryFactory: SavedObjectsRepositoryFactory) => SavedObjectsClientFactory; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md deleted file mode 100644 index 1fc74de6699fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) > [excludedWrappers](./kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md) - -## SavedObjectsClientProviderOptions.excludedWrappers property - -Signature: - -```typescript -excludedWrappers?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md deleted file mode 100644 index a9483e34b38ce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) > [includedHiddenTypes](./kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md) - -## SavedObjectsClientProviderOptions.includedHiddenTypes property - -Signature: - -```typescript -includedHiddenTypes?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md deleted file mode 100644 index a02f54214163b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) - -## SavedObjectsClientProviderOptions interface - -Options to control the creation of the Saved Objects Client. - -Signature: - -```typescript -export interface SavedObjectsClientProviderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludedWrappers?](./kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md) | string\[\] | (Optional) | -| [includedHiddenTypes?](./kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md) | string\[\] | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md deleted file mode 100644 index 722804fd7faa3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) - -## SavedObjectsClientWrapperFactory type - -Describes the factory used to create instances of Saved Objects Client Wrappers. - -Signature: - -```typescript -export declare type SavedObjectsClientWrapperFactory = (options: SavedObjectsClientWrapperOptions) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md deleted file mode 100644 index 1c40647cc8793..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [client](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md) - -## SavedObjectsClientWrapperOptions.client property - -Signature: - -```typescript -client: SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md deleted file mode 100644 index 16d104e4a8dff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) - -## SavedObjectsClientWrapperOptions interface - -Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. - -Signature: - -```typescript -export interface SavedObjectsClientWrapperOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md) | SavedObjectsClientContract | | -| [request](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md) | KibanaRequest | | -| [typeRegistry](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md) | ISavedObjectTypeRegistry | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md deleted file mode 100644 index a76936b44aa73..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [request](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md) - -## SavedObjectsClientWrapperOptions.request property - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md deleted file mode 100644 index 17d23869f6d93..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [typeRegistry](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md) - -## SavedObjectsClientWrapperOptions.typeRegistry property - -Signature: - -```typescript -typeRegistry: ISavedObjectTypeRegistry; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md deleted file mode 100644 index 27432a8805b06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) - -## SavedObjectsClosePointInTimeOptions type - - -Signature: - -```typescript -export declare type SavedObjectsClosePointInTimeOptions = SavedObjectsBaseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md deleted file mode 100644 index 27010232bd46b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) - -## SavedObjectsClosePointInTimeResponse interface - - -Signature: - -```typescript -export interface SavedObjectsClosePointInTimeResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [num\_freed](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md) | number | The number of search contexts that have been successfully closed. | -| [succeeded](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md) | boolean | If true, all search contexts associated with the PIT id are successfully closed. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md deleted file mode 100644 index b64932fcee8f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) > [num\_freed](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md) - -## SavedObjectsClosePointInTimeResponse.num\_freed property - -The number of search contexts that have been successfully closed. - -Signature: - -```typescript -num_freed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md deleted file mode 100644 index 225a549a4cf59..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) > [succeeded](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md) - -## SavedObjectsClosePointInTimeResponse.succeeded property - -If true, all search contexts associated with the PIT id are successfully closed. - -Signature: - -```typescript -succeeded: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md deleted file mode 100644 index 21522a0f32d6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) > [id](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md deleted file mode 100644 index 5f419a63e8c70..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject interface - -An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the `namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option). - -Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with the `namespaceType: 'multiple'`). - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md deleted file mode 100644 index c376a9e4258c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) > [type](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md deleted file mode 100644 index 57298e40a88ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) - -## SavedObjectsCollectMultiNamespaceReferencesOptions interface - -Options for collecting references. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [purpose?](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md) | 'collectMultiNamespaceReferences' \| 'updateObjectsSpaces' | (Optional) Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md deleted file mode 100644 index a36301a6451bc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) > [purpose](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md) - -## SavedObjectsCollectMultiNamespaceReferencesOptions.purpose property - -Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' - -Signature: - -```typescript -purpose?: 'collectMultiNamespaceReferences' | 'updateObjectsSpaces'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md deleted file mode 100644 index 514e9271aa17e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse interface - -The response when object references are collected. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md) | SavedObjectReferenceWithContext\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md deleted file mode 100644 index 4b5707d7228a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) > [objects](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectReferenceWithContext[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md deleted file mode 100644 index e2a4064ec4f33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md) - -## SavedObjectsCreateOptions.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` - -## Remarks - -Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` field set and you want to create it again. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md deleted file mode 100644 index 85529b54bf2cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [id](./kibana-plugin-core-server.savedobjectscreateoptions.id.md) - -## SavedObjectsCreateOptions.id property - -(not recommended) Specify an id for the document - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md deleted file mode 100644 index 43489b8d2e8a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [initialNamespaces](./kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md) - -## SavedObjectsCreateOptions.initialNamespaces property - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md). - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -initialNamespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md deleted file mode 100644 index 646a0f6fcf548..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) - -## SavedObjectsCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. | -| [id?](./kibana-plugin-core-server.savedobjectscreateoptions.id.md) | string | (Optional) (not recommended) Specify an id for the document | -| [initialNamespaces?](./kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md) | string\[\] | (Optional) Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md).\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [originId?](./kibana-plugin-core-server.savedobjectscreateoptions.originid.md) | string | (Optional) Optional ID of the original saved object, if this object's id was regenerated | -| [overwrite?](./kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md) | boolean | (Optional) Overwrite existing documents (defaults to false) | -| [references?](./kibana-plugin-core-server.savedobjectscreateoptions.references.md) | SavedObjectReference\[\] | (Optional) | -| [refresh?](./kibana-plugin-core-server.savedobjectscreateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | -| [version?](./kibana-plugin-core-server.savedobjectscreateoptions.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used in conjunction with overwrite for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md deleted file mode 100644 index 6bc66128623b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md) - -## SavedObjectsCreateOptions.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md deleted file mode 100644 index 14333079f7440..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [originId](./kibana-plugin-core-server.savedobjectscreateoptions.originid.md) - -## SavedObjectsCreateOptions.originId property - -Optional ID of the original saved object, if this object's `id` was regenerated - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md deleted file mode 100644 index 3925cd4ebb2c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [overwrite](./kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md) - -## SavedObjectsCreateOptions.overwrite property - -Overwrite existing documents (defaults to false) - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md deleted file mode 100644 index bbc1c3524694f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [references](./kibana-plugin-core-server.savedobjectscreateoptions.references.md) - -## SavedObjectsCreateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md deleted file mode 100644 index 69f158a69b504..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectscreateoptions.refresh.md) - -## SavedObjectsCreateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md deleted file mode 100644 index 51da57064abb9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [version](./kibana-plugin-core-server.savedobjectscreateoptions.version.md) - -## SavedObjectsCreateOptions.version property - -An opaque version number which changes on each successful write operation. Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md deleted file mode 100644 index 95ab9e225c049..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) > [client](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md) - -## SavedObjectsCreatePointInTimeFinderDependencies.client property - -Signature: - -```typescript -client: Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md deleted file mode 100644 index f647a9c1367b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) - -## SavedObjectsCreatePointInTimeFinderDependencies interface - - -Signature: - -```typescript -export interface SavedObjectsCreatePointInTimeFinderDependencies -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md) | Pick<SavedObjectsClientContract, 'find' \| 'openPointInTimeForType' \| 'closePointInTime'> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md deleted file mode 100644 index 928c6f72bcbf5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderOptions](./kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md) - -## SavedObjectsCreatePointInTimeFinderOptions type - - -Signature: - -```typescript -export declare type SavedObjectsCreatePointInTimeFinderOptions = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md deleted file mode 100644 index 49b6c36cf3ed2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) - -## SavedObjectsDeleteByNamespaceOptions interface - - -Signature: - -```typescript -export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) | boolean | (Optional) The Elasticsearch supports only boolean flag for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md deleted file mode 100644 index 52b562e8e22b7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) - -## SavedObjectsDeleteByNamespaceOptions.refresh property - -The Elasticsearch supports only boolean flag for this operation - -Signature: - -```typescript -refresh?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md deleted file mode 100644 index f869d1f863a9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) > [force](./kibana-plugin-core-server.savedobjectsdeleteoptions.force.md) - -## SavedObjectsDeleteOptions.force property - -Force deletion of an object that exists in multiple namespaces - -Signature: - -```typescript -force?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md deleted file mode 100644 index e1bc1fcec3f2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) - -## SavedObjectsDeleteOptions interface - - -Signature: - -```typescript -export interface SavedObjectsDeleteOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [force?](./kibana-plugin-core-server.savedobjectsdeleteoptions.force.md) | boolean | (Optional) Force deletion of an object that exists in multiple namespaces | -| [refresh?](./kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md deleted file mode 100644 index 3a31b90dd9b7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md) - -## SavedObjectsDeleteOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md deleted file mode 100644 index f101aa98d8bd3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) - -## SavedObjectsErrorHelpers.createBadRequestError() method - -Signature: - -```typescript -static createBadRequestError(reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md deleted file mode 100644 index 426de67ded2dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) - -## SavedObjectsErrorHelpers.createConflictError() method - -Signature: - -```typescript -static createConflictError(type: string, id: string, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md deleted file mode 100644 index 6ac403b442367..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createGenericNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) - -## SavedObjectsErrorHelpers.createGenericNotFoundError() method - -Signature: - -```typescript -static createGenericNotFoundError(type?: string | null, id?: string | null): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| null | | -| id | string \| null | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md deleted file mode 100644 index 4892c0e41ab01..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createGenericNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) - -## SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError() method - -Signature: - -```typescript -static createGenericNotFoundEsUnavailableError(type?: string | null, id?: string | null): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| null | | -| id | string \| null | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md deleted file mode 100644 index 4f9fa9d4484bd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createIndexAliasNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) - -## SavedObjectsErrorHelpers.createIndexAliasNotFoundError() method - -Signature: - -```typescript -static createIndexAliasNotFoundError(alias: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| alias | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md deleted file mode 100644 index 59e2a65694008..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createInvalidVersionError](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) - -## SavedObjectsErrorHelpers.createInvalidVersionError() method - -Signature: - -```typescript -static createInvalidVersionError(versionInput?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| versionInput | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md deleted file mode 100644 index 3d4903c3482ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.createTooManyRequestsError() method - -Signature: - -```typescript -static createTooManyRequestsError(type: string, id: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md deleted file mode 100644 index 4ca95c1565db6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createUnsupportedTypeError](./kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md) - -## SavedObjectsErrorHelpers.createUnsupportedTypeError() method - -Signature: - -```typescript -static createUnsupportedTypeError(type: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md deleted file mode 100644 index 043950407519f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md) - -## SavedObjectsErrorHelpers.decorateBadRequestError() method - -Signature: - -```typescript -static decorateBadRequestError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md deleted file mode 100644 index dfb981a0a656e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md) - -## SavedObjectsErrorHelpers.decorateConflictError() method - -Signature: - -```typescript -static decorateConflictError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md deleted file mode 100644 index 18b019f1b5364..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateEsCannotExecuteScriptError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md) - -## SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError() method - -Signature: - -```typescript -static decorateEsCannotExecuteScriptError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md deleted file mode 100644 index 9d272b1e78454..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md) - -## SavedObjectsErrorHelpers.decorateEsUnavailableError() method - -Signature: - -```typescript -static decorateEsUnavailableError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md deleted file mode 100644 index 11b53ec219334..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateForbiddenError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md) - -## SavedObjectsErrorHelpers.decorateForbiddenError() method - -Signature: - -```typescript -static decorateForbiddenError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md deleted file mode 100644 index 595789611b5c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateGeneralError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md) - -## SavedObjectsErrorHelpers.decorateGeneralError() method - -Signature: - -```typescript -static decorateGeneralError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md deleted file mode 100644 index a2e74ca7769e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateIndexAliasNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md) - -## SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError() method - -Signature: - -```typescript -static decorateIndexAliasNotFoundError(error: Error, alias: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| alias | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md deleted file mode 100644 index d50d5d9ebf45f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateNotAuthorizedError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md) - -## SavedObjectsErrorHelpers.decorateNotAuthorizedError() method - -Signature: - -```typescript -static decorateNotAuthorizedError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md deleted file mode 100644 index 487d64f83ca30..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateRequestEntityTooLargeError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md) - -## SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError() method - -Signature: - -```typescript -static decorateRequestEntityTooLargeError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md deleted file mode 100644 index b85cf196c3cdb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.decorateTooManyRequestsError() method - -Signature: - -```typescript -static decorateTooManyRequestsError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md deleted file mode 100644 index 5dd6a50b61e55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md) - -## SavedObjectsErrorHelpers.isBadRequestError() method - -Signature: - -```typescript -static isBadRequestError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md deleted file mode 100644 index 9762462af9ef3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md) - -## SavedObjectsErrorHelpers.isConflictError() method - -Signature: - -```typescript -static isConflictError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md deleted file mode 100644 index e007dd30f2bb0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isEsCannotExecuteScriptError](./kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md) - -## SavedObjectsErrorHelpers.isEsCannotExecuteScriptError() method - -Signature: - -```typescript -static isEsCannotExecuteScriptError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md deleted file mode 100644 index a6fb911f5e0eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md) - -## SavedObjectsErrorHelpers.isEsUnavailableError() method - -Signature: - -```typescript -static isEsUnavailableError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md deleted file mode 100644 index e45ef7a7ed3f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isForbiddenError](./kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md) - -## SavedObjectsErrorHelpers.isForbiddenError() method - -Signature: - -```typescript -static isForbiddenError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md deleted file mode 100644 index cbec5d3b36a80..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isGeneralError](./kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md) - -## SavedObjectsErrorHelpers.isGeneralError() method - -Signature: - -```typescript -static isGeneralError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md deleted file mode 100644 index 8ad480147adf6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isInvalidVersionError](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) - -## SavedObjectsErrorHelpers.isInvalidVersionError() method - -Signature: - -```typescript -static isInvalidVersionError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md deleted file mode 100644 index 5e85718bde511..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isNotAuthorizedError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) - -## SavedObjectsErrorHelpers.isNotAuthorizedError() method - -Signature: - -```typescript -static isNotAuthorizedError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md deleted file mode 100644 index 05e848322ae9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) - -## SavedObjectsErrorHelpers.isNotFoundError() method - -Signature: - -```typescript -static isNotFoundError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md deleted file mode 100644 index d6674f0a588e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isRequestEntityTooLargeError](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) - -## SavedObjectsErrorHelpers.isRequestEntityTooLargeError() method - -Signature: - -```typescript -static isRequestEntityTooLargeError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md deleted file mode 100644 index 0505c3a450a32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isSavedObjectsClientError](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) - -## SavedObjectsErrorHelpers.isSavedObjectsClientError() method - -Signature: - -```typescript -static isSavedObjectsClientError(error: any): error is DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | any | | - -Returns: - -error is DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md deleted file mode 100644 index 3f9c360710ae3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.isTooManyRequestsError() method - -Signature: - -```typescript -static isTooManyRequestsError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md deleted file mode 100644 index 67056c8a3cb50..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -## SavedObjectsErrorHelpers class - - -Signature: - -```typescript -export declare class SavedObjectsErrorHelpers -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [createBadRequestError(reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) | static | | -| [createConflictError(type, id, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | static | | -| [createGenericNotFoundError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) | static | | -| [createGenericNotFoundEsUnavailableError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) | static | | -| [createIndexAliasNotFoundError(alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) | static | | -| [createInvalidVersionError(versionInput)](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) | static | | -| [createTooManyRequestsError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) | static | | -| [createUnsupportedTypeError(type)](./kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md) | static | | -| [decorateBadRequestError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md) | static | | -| [decorateConflictError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md) | static | | -| [decorateEsCannotExecuteScriptError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md) | static | | -| [decorateEsUnavailableError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md) | static | | -| [decorateForbiddenError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md) | static | | -| [decorateGeneralError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md) | static | | -| [decorateIndexAliasNotFoundError(error, alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md) | static | | -| [decorateNotAuthorizedError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md) | static | | -| [decorateRequestEntityTooLargeError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md) | static | | -| [decorateTooManyRequestsError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md) | static | | -| [isBadRequestError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md) | static | | -| [isConflictError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md) | static | | -| [isEsCannotExecuteScriptError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md) | static | | -| [isEsUnavailableError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md) | static | | -| [isForbiddenError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md) | static | | -| [isGeneralError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md) | static | | -| [isInvalidVersionError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) | static | | -| [isNotAuthorizedError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) | static | | -| [isNotFoundError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) | static | | -| [isRequestEntityTooLargeError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) | static | | -| [isSavedObjectsClientError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) | static | | -| [isTooManyRequestsError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) | static | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md deleted file mode 100644 index 4d3154bb2f7ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) - -## SavedObjectsExportByObjectOptions interface - -Options for the [export by objects API](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) - -Signature: - -```typescript -export interface SavedObjectsExportByObjectOptions extends SavedObjectExportBaseOptions -``` -Extends: SavedObjectExportBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md) | Array<{ id: string; type: string; }> | optional array of objects to export. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md deleted file mode 100644 index a821ffee153be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) > [objects](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md) - -## SavedObjectsExportByObjectOptions.objects property - -optional array of objects to export. - -Signature: - -```typescript -objects: Array<{ - id: string; - type: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md deleted file mode 100644 index a58818e27328a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [hasReference](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md) - -## SavedObjectsExportByTypeOptions.hasReference property - -optional array of references to search object for. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md deleted file mode 100644 index 694e9c0cb14d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) - -## SavedObjectsExportByTypeOptions interface - -Options for the [export by type API](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) - -Signature: - -```typescript -export interface SavedObjectsExportByTypeOptions extends SavedObjectExportBaseOptions -``` -Extends: SavedObjectExportBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hasReference?](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md) | SavedObjectsFindOptionsReference\[\] | (Optional) optional array of references to search object for. | -| [search?](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md) | string | (Optional) optional query string to filter exported objects. | -| [types](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md) | string\[\] | array of saved object types. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md deleted file mode 100644 index ce8c2c87ddaf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [search](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md) - -## SavedObjectsExportByTypeOptions.search property - -optional query string to filter exported objects. - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md deleted file mode 100644 index eed71d7f39d23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [types](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md) - -## SavedObjectsExportByTypeOptions.types property - -array of saved object types. - -Signature: - -```typescript -types: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md deleted file mode 100644 index ee25dbf8c22e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [(constructor)](./kibana-plugin-core-server.savedobjectsexporterror._constructor_.md) - -## SavedObjectsExportError.(constructor) - -Constructs a new instance of the `SavedObjectsExportError` class - -Signature: - -```typescript -constructor(type: string, message: string, attributes?: Record | undefined); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| message | string | | -| attributes | Record<string, any> \| undefined | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md deleted file mode 100644 index 9061399eab1f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [attributes](./kibana-plugin-core-server.savedobjectsexporterror.attributes.md) - -## SavedObjectsExportError.attributes property - -Signature: - -```typescript -readonly attributes?: Record | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md deleted file mode 100644 index b69c46383aae4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [exportSizeExceeded](./kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md) - -## SavedObjectsExportError.exportSizeExceeded() method - -Signature: - -```typescript -static exportSizeExceeded(limit: number): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md deleted file mode 100644 index a6f0190f27fb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [invalidTransformError](./kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md) - -## SavedObjectsExportError.invalidTransformError() method - -Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) performed an invalid operation during the transform, such as removing objects from the export, or changing an object's type or id. - -Signature: - -```typescript -static invalidTransformError(objectKeys: string[]): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objectKeys | string\[\] | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md deleted file mode 100644 index 4c70b8395d8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) - -## SavedObjectsExportError class - - -Signature: - -```typescript -export declare class SavedObjectsExportError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(type, message, attributes)](./kibana-plugin-core-server.savedobjectsexporterror._constructor_.md) | | Constructs a new instance of the SavedObjectsExportError class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [attributes?](./kibana-plugin-core-server.savedobjectsexporterror.attributes.md) | | Record<string, any> \| undefined | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsexporterror.type.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [exportSizeExceeded(limit)](./kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md) | static | | -| [invalidTransformError(objectKeys)](./kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md) | static | Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) performed an invalid operation during the transform, such as removing objects from the export, or changing an object's type or id. | -| [objectFetchError(objects)](./kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md) | static | | -| [objectTransformError(objects, cause)](./kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md) | static | Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) threw an error | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md deleted file mode 100644 index 172b9e0f3ef18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [objectFetchError](./kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md) - -## SavedObjectsExportError.objectFetchError() method - -Signature: - -```typescript -static objectFetchError(objects: SavedObject[]): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md deleted file mode 100644 index 46d415068e9e5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [objectTransformError](./kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md) - -## SavedObjectsExportError.objectTransformError() method - -Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) threw an error - -Signature: - -```typescript -static objectTransformError(objects: SavedObject[], cause: Error): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | -| cause | Error | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md deleted file mode 100644 index 0c1cda48246ad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [type](./kibana-plugin-core-server.savedobjectsexporterror.type.md) - -## SavedObjectsExportError.type property - -Signature: - -```typescript -readonly type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md deleted file mode 100644 index f7b96e71c8e53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [id](./kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md) - -## SavedObjectsExportExcludedObject.id property - -id of the excluded object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md deleted file mode 100644 index 053e9b8bec463..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) - -## SavedObjectsExportExcludedObject interface - - -Signature: - -```typescript -export interface SavedObjectsExportExcludedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md) | string | id of the excluded object | -| [reason?](./kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md) | string | (Optional) optional cause of the exclusion | -| [type](./kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md) | string | type of the excluded object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md deleted file mode 100644 index 0adb1ba35e696..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [reason](./kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md) - -## SavedObjectsExportExcludedObject.reason property - -optional cause of the exclusion - -Signature: - -```typescript -reason?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md deleted file mode 100644 index be28ac2d0ffb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [type](./kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md) - -## SavedObjectsExportExcludedObject.type property - -type of the excluded object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md deleted file mode 100644 index 90432bf6d6705..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [excludedObjects](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md) - -## SavedObjectsExportResultDetails.excludedObjects property - -excluded objects details - -Signature: - -```typescript -excludedObjects: SavedObjectsExportExcludedObject[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md deleted file mode 100644 index 05846e28b9cab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [excludedObjectsCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md) - -## SavedObjectsExportResultDetails.excludedObjectsCount property - -number of objects that were excluded from the export - -Signature: - -```typescript -excludedObjectsCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md deleted file mode 100644 index 4ff59fcc2bce4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [exportedCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md) - -## SavedObjectsExportResultDetails.exportedCount property - -number of successfully exported objects - -Signature: - -```typescript -exportedCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md deleted file mode 100644 index 872147dc81456..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) - -## SavedObjectsExportResultDetails interface - -Structure of the export result details entry - -Signature: - -```typescript -export interface SavedObjectsExportResultDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludedObjects](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md) | SavedObjectsExportExcludedObject\[\] | excluded objects details | -| [excludedObjectsCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md) | number | number of objects that were excluded from the export | -| [exportedCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md) | number | number of successfully exported objects | -| [missingRefCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md) | number | number of missing references | -| [missingReferences](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md) | Array<{ id: string; type: string; }> | missing references details | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md deleted file mode 100644 index dfab4699ede7c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [missingRefCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md) - -## SavedObjectsExportResultDetails.missingRefCount property - -number of missing references - -Signature: - -```typescript -missingRefCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md deleted file mode 100644 index a5b51c38a4cab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [missingReferences](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md) - -## SavedObjectsExportResultDetails.missingReferences property - -missing references details - -Signature: - -```typescript -missingReferences: Array<{ - id: string; - type: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md deleted file mode 100644 index 2f83d5188e891..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md +++ /dev/null @@ -1,84 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransform](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -## SavedObjectsExportTransform type - -Transformation function used to mutate the exported objects of the associated type. - -A type's export transform function will be executed once per user-initiated export, for all objects of that type. - -Signature: - -```typescript -export declare type SavedObjectsExportTransform = (context: SavedObjectsExportTransformContext, objects: Array>) => SavedObject[] | Promise; -``` - -## Remarks - -Trying to change an object's id or type during the transform will result in a runtime error during the export process. - -## Example 1 - -Registering a transform function changing the object's attributes during the export - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: (ctx, objects) => { - return objects.map((obj) => ({ - ...obj, - attributes: { - ...obj.attributes, - enabled: false, - } - }) - } - }, - }); - } -} -``` - -## Example 2 - -Registering a transform function adding additional objects to the export - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - const savedObjectStartContractPromise = getStartServices().then( - ([{ savedObjects: savedObjectsStart }]) => savedObjectsStart - ); - - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: async (ctx, objects) => { - const { getScopedClient } = await savedObjectStartContractPromise; - const client = getScopedClient(ctx.request); - - const depResponse = await client.find({ - type: 'my-nested-object', - hasReference: objs.map(({ id, type }) => ({ id, type })), - }); - - return [...objs, ...depResponse.saved_objects]; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md deleted file mode 100644 index c277308c6fc3b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) - -## SavedObjectsExportTransformContext interface - -Context passed down to a [export transform function](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -Signature: - -```typescript -export interface SavedObjectsExportTransformContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [request](./kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md) | KibanaRequest | The request that initiated the export request. Can be used to create scoped services or client inside the [transformation](./kibana-plugin-core-server.savedobjectsexporttransform.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md deleted file mode 100644 index fe04698899c7c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) > [request](./kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md) - -## SavedObjectsExportTransformContext.request property - -The request that initiated the export request. Can be used to create scoped services or client inside the [transformation](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md deleted file mode 100644 index cf5b5d7e6e339..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md) - -## SavedObjectsFieldMapping type - -Describe a [saved object type mapping](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) field. - -Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation - -Signature: - -```typescript -export declare type SavedObjectsFieldMapping = estypes.MappingProperty & { - dynamic?: false | 'strict'; - properties?: Record; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md deleted file mode 100644 index b716ed43948e4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [defaultSearchOperator](./kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md) - -## SavedObjectsFindOptions.defaultSearchOperator property - -The search operator to use with the provided filter. Defaults to `OR` - -Signature: - -```typescript -defaultSearchOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md deleted file mode 100644 index bb7d0a8ff861c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [fields](./kibana-plugin-core-server.savedobjectsfindoptions.fields.md) - -## SavedObjectsFindOptions.fields property - -An array of fields to include in the results - -Signature: - -```typescript -fields?: string[]; -``` - -## Example - -SavedObjects.find({type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]}) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md deleted file mode 100644 index c98a4fe5e8796..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [filter](./kibana-plugin-core-server.savedobjectsfindoptions.filter.md) - -## SavedObjectsFindOptions.filter property - -Signature: - -```typescript -filter?: string | KueryNode; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md deleted file mode 100644 index dea3d55950789..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [hasReference](./kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md) - -## SavedObjectsFindOptions.hasReference property - -Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md deleted file mode 100644 index 2c06f76d5c736..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [hasReferenceOperator](./kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md) - -## SavedObjectsFindOptions.hasReferenceOperator property - -The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - -Signature: - -```typescript -hasReferenceOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md deleted file mode 100644 index 9e87eff2f1232..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) - -## SavedObjectsFindOptions interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchOperator?](./kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md) | 'AND' \| 'OR' | (Optional) The search operator to use with the provided filter. Defaults to OR | -| [fields?](./kibana-plugin-core-server.savedobjectsfindoptions.fields.md) | string\[\] | (Optional) An array of fields to include in the results | -| [filter?](./kibana-plugin-core-server.savedobjectsfindoptions.filter.md) | string \| KueryNode | (Optional) | -| [hasReference?](./kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md) | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | (Optional) Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. | -| [hasReferenceOperator?](./kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md) | 'AND' \| 'OR' | (Optional) The operator to use when searching by multiple references using the hasReference option. Defaults to OR | -| [namespaces?](./kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md) | string\[\] | (Optional) | -| [page?](./kibana-plugin-core-server.savedobjectsfindoptions.page.md) | number | (Optional) | -| [perPage?](./kibana-plugin-core-server.savedobjectsfindoptions.perpage.md) | number | (Optional) | -| [pit?](./kibana-plugin-core-server.savedobjectsfindoptions.pit.md) | SavedObjectsPitParams | (Optional) Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). | -| [preference?](./kibana-plugin-core-server.savedobjectsfindoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query \* | -| [rootSearchFields?](./kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. | -| [search?](./kibana-plugin-core-server.savedobjectsfindoptions.search.md) | string | (Optional) Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information | -| [searchAfter?](./kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md) | estypes.Id\[\] | (Optional) Use the sort values from the previous page to retrieve the next page of results. | -| [searchFields?](./kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information | -| [sortField?](./kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md) | string | (Optional) | -| [sortOrder?](./kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md) | estypes.SortOrder | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsfindoptions.type.md) | string \| string\[\] | | -| [typeToNamespacesMap?](./kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md) | Map<string, string\[\] \| undefined> | (Optional) This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md deleted file mode 100644 index cae707baa58c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [namespaces](./kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md) - -## SavedObjectsFindOptions.namespaces property - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md deleted file mode 100644 index 5a2f05af843b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [page](./kibana-plugin-core-server.savedobjectsfindoptions.page.md) - -## SavedObjectsFindOptions.page property - -Signature: - -```typescript -page?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md deleted file mode 100644 index 39191ae00c8f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [perPage](./kibana-plugin-core-server.savedobjectsfindoptions.perpage.md) - -## SavedObjectsFindOptions.perPage property - -Signature: - -```typescript -perPage?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md deleted file mode 100644 index fac333227088c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [pit](./kibana-plugin-core-server.savedobjectsfindoptions.pit.md) - -## SavedObjectsFindOptions.pit property - -Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -Signature: - -```typescript -pit?: SavedObjectsPitParams; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md deleted file mode 100644 index c9e1c168e7a1b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [preference](./kibana-plugin-core-server.savedobjectsfindoptions.preference.md) - -## SavedObjectsFindOptions.preference property - -An optional ES preference value to be used for the query \* - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md deleted file mode 100644 index 204342c45f64e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [rootSearchFields](./kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md) - -## SavedObjectsFindOptions.rootSearchFields property - -The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not be modified. If used in conjunction with `searchFields`, both are concatenated together. - -Signature: - -```typescript -rootSearchFields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md deleted file mode 100644 index fdf7cc1fb94c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [search](./kibana-plugin-core-server.savedobjectsfindoptions.search.md) - -## SavedObjectsFindOptions.search property - -Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md deleted file mode 100644 index 9afd602259a78..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [searchAfter](./kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md) - -## SavedObjectsFindOptions.searchAfter property - -Use the sort values from the previous page to retrieve the next page of results. - -Signature: - -```typescript -searchAfter?: estypes.Id[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md deleted file mode 100644 index ba1152c05eb37..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [searchFields](./kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md) - -## SavedObjectsFindOptions.searchFields property - -The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information - -Signature: - -```typescript -searchFields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md deleted file mode 100644 index 1dffe996d5726..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [sortField](./kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md) - -## SavedObjectsFindOptions.sortField property - -Signature: - -```typescript -sortField?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md deleted file mode 100644 index e1c657e3a5171..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [sortOrder](./kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md) - -## SavedObjectsFindOptions.sortOrder property - -Signature: - -```typescript -sortOrder?: estypes.SortOrder; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md deleted file mode 100644 index b1503984fdd44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [type](./kibana-plugin-core-server.savedobjectsfindoptions.type.md) - -## SavedObjectsFindOptions.type property - -Signature: - -```typescript -type: string | string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md deleted file mode 100644 index 8bec759f05580..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [typeToNamespacesMap](./kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md) - -## SavedObjectsFindOptions.typeToNamespacesMap property - -This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. - -Signature: - -```typescript -typeToNamespacesMap?: Map; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md deleted file mode 100644 index 6d5b76d685680..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) > [id](./kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md) - -## SavedObjectsFindOptionsReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md deleted file mode 100644 index 21eb9f06cc11d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) - -## SavedObjectsFindOptionsReference interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptionsReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md deleted file mode 100644 index 0d7db3d72a457..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) > [type](./kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md) - -## SavedObjectsFindOptionsReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md deleted file mode 100644 index 17a899f4c8280..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) - -## SavedObjectsFindResponse.aggregations property - -Signature: - -```typescript -aggregations?: A; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md deleted file mode 100644 index 4afb825fd0f44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) - -## SavedObjectsFindResponse interface - -Return type of the Saved Objects `find()` method. - -\*Note\*: this type is different between the Public and Server Saved Objects clients. - -Signature: - -```typescript -export interface SavedObjectsFindResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aggregations?](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) | A | (Optional) | -| [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) | number | | -| [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) | number | | -| [pit\_id?](./kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md) | string | (Optional) | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md) | Array<SavedObjectsFindResult<T>> | | -| [total](./kibana-plugin-core-server.savedobjectsfindresponse.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md deleted file mode 100644 index 82e18ac4f3f8f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) - -## SavedObjectsFindResponse.page property - -Signature: - -```typescript -page: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md deleted file mode 100644 index 551aea487fe4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) - -## SavedObjectsFindResponse.per\_page property - -Signature: - -```typescript -per_page: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md deleted file mode 100644 index dc4f9b509d606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [pit\_id](./kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md) - -## SavedObjectsFindResponse.pit\_id property - -Signature: - -```typescript -pit_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md deleted file mode 100644 index 7a91367f6ef0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md) - -## SavedObjectsFindResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md deleted file mode 100644 index 3a6b4309f2e7a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [total](./kibana-plugin-core-server.savedobjectsfindresponse.total.md) - -## SavedObjectsFindResponse.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md deleted file mode 100644 index f2ba01697da17..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) - -## SavedObjectsFindResult interface - - -Signature: - -```typescript -export interface SavedObjectsFindResult extends SavedObject -``` -Extends: SavedObject<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [score](./kibana-plugin-core-server.savedobjectsfindresult.score.md) | number | The Elasticsearch _score of this result. | -| [sort?](./kibana-plugin-core-server.savedobjectsfindresult.sort.md) | string\[\] | (Optional) The Elasticsearch sort value of this result. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md deleted file mode 100644 index c6646df6ee470..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) > [score](./kibana-plugin-core-server.savedobjectsfindresult.score.md) - -## SavedObjectsFindResult.score property - -The Elasticsearch `_score` of this result. - -Signature: - -```typescript -score: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md deleted file mode 100644 index 5df1b3291b072..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) > [sort](./kibana-plugin-core-server.savedobjectsfindresult.sort.md) - -## SavedObjectsFindResult.sort property - -The Elasticsearch `sort` value of this result. - -Signature: - -```typescript -sort?: string[]; -``` - -## Remarks - -This can be passed directly to the `searchAfter` param in the [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) in order to page through large numbers of hits. It is recommended you use this alongside a Point In Time (PIT) that was opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -## Example - - -```ts -const { id } = await savedObjectsClient.openPointInTimeForType('visualization'); -const page1 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id }, -}); -const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; -const page2 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id: page1.pit_id }, - searchAfter: lastHit.sort, -}); -await savedObjectsClient.closePointInTime(page2.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md deleted file mode 100644 index f52fd9057d9d0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) - -## SavedObjectsImportActionRequiredWarning.actionPath property - -The path (without the basePath) that the user should be redirect to address this warning. - -Signature: - -```typescript -actionPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md deleted file mode 100644 index 7fb5d53c487af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [buttonLabel](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md) - -## SavedObjectsImportActionRequiredWarning.buttonLabel property - -An optional label to use for the link button. If unspecified, a default label will be used. - -Signature: - -```typescript -buttonLabel?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md deleted file mode 100644 index c4ec5fdd2f8e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) - -## SavedObjectsImportActionRequiredWarning interface - -A warning meant to notify that a specific user action is required to finalize the import of some type of object. - - The `actionUrl` must be a path relative to the basePath, and not include it. - -Signature: - -```typescript -export interface SavedObjectsImportActionRequiredWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) | string | The path (without the basePath) that the user should be redirect to address this warning. | -| [buttonLabel?](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md) | string | (Optional) An optional label to use for the link button. If unspecified, a default label will be used. | -| [message](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md) | string | The translated message to display to the user. | -| [type](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md) | 'action\_required' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md deleted file mode 100644 index 1ab9afd4bad99..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [message](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md) - -## SavedObjectsImportActionRequiredWarning.message property - -The translated message to display to the user. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md deleted file mode 100644 index d8f22ef17d8f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [type](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md) - -## SavedObjectsImportActionRequiredWarning.type property - -Signature: - -```typescript -type: 'action_required'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md deleted file mode 100644 index 445979dd740d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) > [destinations](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md) - -## SavedObjectsImportAmbiguousConflictError.destinations property - -Signature: - -```typescript -destinations: Array<{ - id: string; - title?: string; - updatedAt?: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md deleted file mode 100644 index 7d275fa199c5b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) - -## SavedObjectsImportAmbiguousConflictError interface - -Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. - -Signature: - -```typescript -export interface SavedObjectsImportAmbiguousConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinations](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md) | Array<{ id: string; title?: string; updatedAt?: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md) | 'ambiguous\_conflict' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md deleted file mode 100644 index ca98682873033..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) > [type](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md) - -## SavedObjectsImportAmbiguousConflictError.type property - -Signature: - -```typescript -type: 'ambiguous_conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md deleted file mode 100644 index 858f171223472..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md) - -## SavedObjectsImportConflictError.destinationId property - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md deleted file mode 100644 index 9456e042035fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) - -## SavedObjectsImportConflictError interface - -Represents a failure to import due to a conflict. - -Signature: - -```typescript -export interface SavedObjectsImportConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md) | string | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsimportconflicterror.type.md) | 'conflict' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md deleted file mode 100644 index 15ceed56fb22f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) > [type](./kibana-plugin-core-server.savedobjectsimportconflicterror.type.md) - -## SavedObjectsImportConflictError.type property - -Signature: - -```typescript -type: 'conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md deleted file mode 100644 index 6d09d4cb88120..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [attributes](./kibana-plugin-core-server.savedobjectsimporterror.attributes.md) - -## SavedObjectsImportError.attributes property - -Signature: - -```typescript -readonly attributes?: Record | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md deleted file mode 100644 index 421557445670e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [importSizeExceeded](./kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md) - -## SavedObjectsImportError.importSizeExceeded() method - -Signature: - -```typescript -static importSizeExceeded(limit: number): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md deleted file mode 100644 index 2e4fd1a01eb04..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) - -## SavedObjectsImportError class - - -Signature: - -```typescript -export declare class SavedObjectsImportError extends Error -``` -Extends: Error - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [attributes?](./kibana-plugin-core-server.savedobjectsimporterror.attributes.md) | | Record<string, any> \| undefined | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsimporterror.type.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [importSizeExceeded(limit)](./kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md) | static | | -| [nonUniqueImportObjects(nonUniqueEntries)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md) | static | | -| [nonUniqueRetryDestinations(nonUniqueRetryDestinations)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md) | static | | -| [nonUniqueRetryObjects(nonUniqueRetryObjects)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md) | static | | -| [referencesFetchError(objects)](./kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md) | static | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md deleted file mode 100644 index 29533db10302c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueImportObjects](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md) - -## SavedObjectsImportError.nonUniqueImportObjects() method - -Signature: - -```typescript -static nonUniqueImportObjects(nonUniqueEntries: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueEntries | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md deleted file mode 100644 index 4fd23c3f6d62d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueRetryDestinations](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md) - -## SavedObjectsImportError.nonUniqueRetryDestinations() method - -Signature: - -```typescript -static nonUniqueRetryDestinations(nonUniqueRetryDestinations: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueRetryDestinations | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md deleted file mode 100644 index bf8a2c2c01760..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueRetryObjects](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md) - -## SavedObjectsImportError.nonUniqueRetryObjects() method - -Signature: - -```typescript -static nonUniqueRetryObjects(nonUniqueRetryObjects: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueRetryObjects | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md deleted file mode 100644 index 4202f164900b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [referencesFetchError](./kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md) - -## SavedObjectsImportError.referencesFetchError() method - -Signature: - -```typescript -static referencesFetchError(objects: SavedObject[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md deleted file mode 100644 index db655f8cfa129..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [type](./kibana-plugin-core-server.savedobjectsimporterror.type.md) - -## SavedObjectsImportError.type property - -Signature: - -```typescript -readonly type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md deleted file mode 100644 index 40c9fa1fefa91..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [error](./kibana-plugin-core-server.savedobjectsimportfailure.error.md) - -## SavedObjectsImportFailure.error property - -Signature: - -```typescript -error: SavedObjectsImportConflictError | SavedObjectsImportAmbiguousConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md deleted file mode 100644 index a58183b84e401..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [id](./kibana-plugin-core-server.savedobjectsimportfailure.id.md) - -## SavedObjectsImportFailure.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md deleted file mode 100644 index 4bdc3d99028ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) - -## SavedObjectsImportFailure interface - -Represents a failure to import. - -Signature: - -```typescript -export interface SavedObjectsImportFailure -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-server.savedobjectsimportfailure.error.md) | SavedObjectsImportConflictError \| SavedObjectsImportAmbiguousConflictError \| SavedObjectsImportUnsupportedTypeError \| SavedObjectsImportMissingReferencesError \| SavedObjectsImportUnknownError | | -| [id](./kibana-plugin-core-server.savedobjectsimportfailure.id.md) | string | | -| [meta](./kibana-plugin-core-server.savedobjectsimportfailure.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md) | boolean | (Optional) If overwrite is specified, an attempt was made to overwrite an existing object. | -| [type](./kibana-plugin-core-server.savedobjectsimportfailure.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md deleted file mode 100644 index c345ebe28b945..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [meta](./kibana-plugin-core-server.savedobjectsimportfailure.meta.md) - -## SavedObjectsImportFailure.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md deleted file mode 100644 index 0bd3f1c1d72e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md) - -## SavedObjectsImportFailure.overwrite property - -If `overwrite` is specified, an attempt was made to overwrite an existing object. - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md deleted file mode 100644 index ff1529eb8db7a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [type](./kibana-plugin-core-server.savedobjectsimportfailure.type.md) - -## SavedObjectsImportFailure.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md deleted file mode 100644 index 8d50ef94577de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHook](./kibana-plugin-core-server.savedobjectsimporthook.md) - -## SavedObjectsImportHook type - -A hook associated with a specific saved object type, that will be invoked during the import process. The hook will have access to the objects of the registered type. - -Currently, the only supported feature for import hooks is to return warnings to be displayed in the UI when the import succeeds. - - The only interactions the hook can have with the import process is via the hook's response. Mutating the objects inside the hook's code will have no effect. - -Signature: - -```typescript -export declare type SavedObjectsImportHook = (objects: Array>) => SavedObjectsImportHookResult | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md deleted file mode 100644 index eb16aa2fb0285..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) - -## SavedObjectsImportHookResult interface - -Result from a [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) - -Signature: - -```typescript -export interface SavedObjectsImportHookResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [warnings?](./kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md) | SavedObjectsImportWarning\[\] | (Optional) An optional list of warnings to display in the UI when the import succeeds. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md deleted file mode 100644 index 682b384f8d363..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) > [warnings](./kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md) - -## SavedObjectsImportHookResult.warnings property - -An optional list of warnings to display in the UI when the import succeeds. - -Signature: - -```typescript -warnings?: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md deleted file mode 100644 index 25d2a88e87e8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) - -## SavedObjectsImportMissingReferencesError interface - -Represents a failure to import due to missing references. - -Signature: - -```typescript -export interface SavedObjectsImportMissingReferencesError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md) | Array<{ type: string; id: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md) | 'missing\_references' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md deleted file mode 100644 index f8255e8c75f92..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) > [references](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md) - -## SavedObjectsImportMissingReferencesError.references property - -Signature: - -```typescript -references: Array<{ - type: string; - id: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md deleted file mode 100644 index 4499f82ed92ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) > [type](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md) - -## SavedObjectsImportMissingReferencesError.type property - -Signature: - -```typescript -type: 'missing_references'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md deleted file mode 100644 index 23c6fe0051746..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [createNewCopies](./kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md) - -## SavedObjectsImportOptions.createNewCopies property - -If true, will create new copies of import objects, each with a random `id` and undefined `originId`. - -Signature: - -```typescript -createNewCopies: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md deleted file mode 100644 index 775f3a4c9acb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) - -## SavedObjectsImportOptions interface - -Options to control the import operation. - -Signature: - -```typescript -export interface SavedObjectsImportOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopies](./kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md) | boolean | If true, will create new copies of import objects, each with a random id and undefined originId. | -| [namespace?](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) | string | (Optional) if specified, will import in given namespace, else will import as global object | -| [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) | boolean | If true, will override existing object if present. Note: this has no effect when used with the createNewCopies option. | -| [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import | -| [refresh?](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) | boolean \| 'wait\_for' | (Optional) Refresh setting, defaults to wait_for | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md deleted file mode 100644 index 188ff03092e0c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) - -## SavedObjectsImportOptions.namespace property - -if specified, will import in given namespace, else will import as global object - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md deleted file mode 100644 index 1e9192c47679d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) - -## SavedObjectsImportOptions.overwrite property - -If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option. - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md deleted file mode 100644 index bf68ee47d21fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) - -## SavedObjectsImportOptions.readStream property - -The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import - -Signature: - -```typescript -readStream: Readable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md deleted file mode 100644 index cc7e36354647a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) - -## SavedObjectsImportOptions.refresh property - -Refresh setting, defaults to `wait_for` - -Signature: - -```typescript -refresh?: boolean | 'wait_for'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md deleted file mode 100644 index dc6f782fc937f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [errors](./kibana-plugin-core-server.savedobjectsimportresponse.errors.md) - -## SavedObjectsImportResponse.errors property - -Signature: - -```typescript -errors?: SavedObjectsImportFailure[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md deleted file mode 100644 index e39b4b02bb55d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) - -## SavedObjectsImportResponse interface - -The response describing the result of an import. - -Signature: - -```typescript -export interface SavedObjectsImportResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors?](./kibana-plugin-core-server.savedobjectsimportresponse.errors.md) | SavedObjectsImportFailure\[\] | (Optional) | -| [success](./kibana-plugin-core-server.savedobjectsimportresponse.success.md) | boolean | | -| [successCount](./kibana-plugin-core-server.savedobjectsimportresponse.successcount.md) | number | | -| [successResults?](./kibana-plugin-core-server.savedobjectsimportresponse.successresults.md) | SavedObjectsImportSuccess\[\] | (Optional) | -| [warnings](./kibana-plugin-core-server.savedobjectsimportresponse.warnings.md) | SavedObjectsImportWarning\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md deleted file mode 100644 index fc4f98cd2556e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [success](./kibana-plugin-core-server.savedobjectsimportresponse.success.md) - -## SavedObjectsImportResponse.success property - -Signature: - -```typescript -success: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md deleted file mode 100644 index 3186437a10482..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [successCount](./kibana-plugin-core-server.savedobjectsimportresponse.successcount.md) - -## SavedObjectsImportResponse.successCount property - -Signature: - -```typescript -successCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md deleted file mode 100644 index 63951d3a0b25f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [successResults](./kibana-plugin-core-server.savedobjectsimportresponse.successresults.md) - -## SavedObjectsImportResponse.successResults property - -Signature: - -```typescript -successResults?: SavedObjectsImportSuccess[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md deleted file mode 100644 index 88cccf7f527e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [warnings](./kibana-plugin-core-server.savedobjectsimportresponse.warnings.md) - -## SavedObjectsImportResponse.warnings property - -Signature: - -```typescript -warnings: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md deleted file mode 100644 index e9cc92c55ded1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [createNewCopy](./kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md) - -## SavedObjectsImportRetry.createNewCopy property - -If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md deleted file mode 100644 index 9a3ccf4442db7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportretry.destinationid.md) - -## SavedObjectsImportRetry.destinationId property - -The object ID that will be created or overwritten. If not specified, the `id` field will be used. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md deleted file mode 100644 index d42b1e3ad7581..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [id](./kibana-plugin-core-server.savedobjectsimportretry.id.md) - -## SavedObjectsImportRetry.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md deleted file mode 100644 index a23bec3c5341f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [ignoreMissingReferences](./kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md) - -## SavedObjectsImportRetry.ignoreMissingReferences property - -If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. - -Signature: - -```typescript -ignoreMissingReferences?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md deleted file mode 100644 index b79ec63ed86c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) - -## SavedObjectsImportRetry interface - -Describes a retry operation for importing a saved object. - -Signature: - -```typescript -export interface SavedObjectsImportRetry -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md) | boolean | (Optional) If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportretry.destinationid.md) | string | (Optional) The object ID that will be created or overwritten. If not specified, the id field will be used. | -| [id](./kibana-plugin-core-server.savedobjectsimportretry.id.md) | string | | -| [ignoreMissingReferences?](./kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md) | boolean | (Optional) If ignoreMissingReferences is specified, reference validation will be skipped for this object. | -| [overwrite](./kibana-plugin-core-server.savedobjectsimportretry.overwrite.md) | boolean | | -| [replaceReferences](./kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md) | Array<{ type: string; from: string; to: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportretry.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md deleted file mode 100644 index f4358ab986563..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportretry.overwrite.md) - -## SavedObjectsImportRetry.overwrite property - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md deleted file mode 100644 index b25940d9ab2ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [replaceReferences](./kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md) - -## SavedObjectsImportRetry.replaceReferences property - -Signature: - -```typescript -replaceReferences: Array<{ - type: string; - from: string; - to: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md deleted file mode 100644 index 2e434c4a57e9b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [type](./kibana-plugin-core-server.savedobjectsimportretry.type.md) - -## SavedObjectsImportRetry.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md deleted file mode 100644 index 7dc4285400478..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) - -## SavedObjectsImportSimpleWarning interface - -A simple informative warning that will be displayed to the user. - -Signature: - -```typescript -export interface SavedObjectsImportSimpleWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md) | string | The translated message to display to the user | -| [type](./kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md) | 'simple' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md deleted file mode 100644 index 1e3ac7ec11365..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) > [message](./kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md) - -## SavedObjectsImportSimpleWarning.message property - -The translated message to display to the user - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md deleted file mode 100644 index 660b1b39d6c39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) > [type](./kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md) - -## SavedObjectsImportSimpleWarning.type property - -Signature: - -```typescript -type: 'simple'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md deleted file mode 100644 index 3473a4f4577e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [createNewCopy](./kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md) - -## SavedObjectsImportSuccess.createNewCopy property - -> Warning: This API is now obsolete. -> -> Can be removed when https://github.com/elastic/kibana/issues/91615 is done. If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, this field will be redundant and can be removed. -> - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md deleted file mode 100644 index c5acc51c3ec99..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md) - -## SavedObjectsImportSuccess.destinationId property - -If `destinationId` is specified, the new object has a new ID that is different from the import ID. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md deleted file mode 100644 index 5b95f7f64bfac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [id](./kibana-plugin-core-server.savedobjectsimportsuccess.id.md) - -## SavedObjectsImportSuccess.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md deleted file mode 100644 index 74242ba6d75be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) - -## SavedObjectsImportSuccess interface - -Represents a successful import. - -Signature: - -```typescript -export interface SavedObjectsImportSuccess -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md) | boolean | (Optional) | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md) | string | (Optional) If destinationId is specified, the new object has a new ID that is different from the import ID. | -| [id](./kibana-plugin-core-server.savedobjectsimportsuccess.id.md) | string | | -| [meta](./kibana-plugin-core-server.savedobjectsimportsuccess.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md) | boolean | (Optional) If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). | -| [type](./kibana-plugin-core-server.savedobjectsimportsuccess.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md deleted file mode 100644 index de6057b4729ec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [meta](./kibana-plugin-core-server.savedobjectsimportsuccess.meta.md) - -## SavedObjectsImportSuccess.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md deleted file mode 100644 index 80cb659ef2cd2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md) - -## SavedObjectsImportSuccess.overwrite property - -If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md deleted file mode 100644 index e6aa894cd0af9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [type](./kibana-plugin-core-server.savedobjectsimportsuccess.type.md) - -## SavedObjectsImportSuccess.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md deleted file mode 100644 index 158afd45752fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) - -## SavedObjectsImportUnknownError interface - -Represents a failure to import due to an unknown reason. - -Signature: - -```typescript -export interface SavedObjectsImportUnknownError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-server.savedobjectsimportunknownerror.message.md) | string | | -| [statusCode](./kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md) | number | | -| [type](./kibana-plugin-core-server.savedobjectsimportunknownerror.type.md) | 'unknown' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md deleted file mode 100644 index b5fb8b9db0e10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [message](./kibana-plugin-core-server.savedobjectsimportunknownerror.message.md) - -## SavedObjectsImportUnknownError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md deleted file mode 100644 index 0fa38614e8735..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [statusCode](./kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md) - -## SavedObjectsImportUnknownError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md deleted file mode 100644 index c22a1dec73789..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [type](./kibana-plugin-core-server.savedobjectsimportunknownerror.type.md) - -## SavedObjectsImportUnknownError.type property - -Signature: - -```typescript -type: 'unknown'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md deleted file mode 100644 index 48aff60c69d13..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) - -## SavedObjectsImportUnsupportedTypeError interface - -Represents a failure to import due to having an unsupported saved object type. - -Signature: - -```typescript -export interface SavedObjectsImportUnsupportedTypeError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md) | 'unsupported\_type' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md deleted file mode 100644 index a985d4d8793bb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) > [type](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md) - -## SavedObjectsImportUnsupportedTypeError.type property - -Signature: - -```typescript -type: 'unsupported_type'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md deleted file mode 100644 index 257751f16601d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportWarning](./kibana-plugin-core-server.savedobjectsimportwarning.md) - -## SavedObjectsImportWarning type - -Composite type of all the possible types of import warnings. - -See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) for more details. - -Signature: - -```typescript -export declare type SavedObjectsImportWarning = SavedObjectsImportSimpleWarning | SavedObjectsImportActionRequiredWarning; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md deleted file mode 100644 index 44c3ab18fea61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) > [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md) - -## SavedObjectsIncrementCounterField.fieldName property - -The field name to increment the counter by. - -Signature: - -```typescript -fieldName: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md deleted file mode 100644 index dc6f8b114c1c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) > [incrementBy](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md) - -## SavedObjectsIncrementCounterField.incrementBy property - -The number to increment the field by (defaults to 1). - -Signature: - -```typescript -incrementBy?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md deleted file mode 100644 index a45d48523f461..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) - -## SavedObjectsIncrementCounterField interface - - -Signature: - -```typescript -export interface SavedObjectsIncrementCounterField -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md) | string | The field name to increment the counter by. | -| [incrementBy?](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md) | number | (Optional) The number to increment the field by (defaults to 1). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md deleted file mode 100644 index 61091306d0dbc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [initialize](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md) - -## SavedObjectsIncrementCounterOptions.initialize property - -(default=false) If true, sets all the counter fields to 0 if they don't already exist. Existing fields will be left as-is and won't be incremented. - -Signature: - -```typescript -initialize?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md deleted file mode 100644 index 8740ffb1be185..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) - -## SavedObjectsIncrementCounterOptions interface - - -Signature: - -```typescript -export interface SavedObjectsIncrementCounterOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [initialize?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md) | boolean | (Optional) (default=false) If true, sets all the counter fields to 0 if they don't already exist. Existing fields will be left as-is and won't be incremented. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) | -| [refresh?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) (default='wait\_for') The Elasticsearch refresh setting for this operation. See [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) | -| [upsertAttributes?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md) | Attributes | (Optional) Attributes to use when upserting the document if it doesn't exist. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md deleted file mode 100644 index aff80138d61cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md) - -## SavedObjectsIncrementCounterOptions.migrationVersion property - -[SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md deleted file mode 100644 index 4f217cc223d46..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md) - -## SavedObjectsIncrementCounterOptions.refresh property - -(default='wait\_for') The Elasticsearch refresh setting for this operation. See [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md deleted file mode 100644 index d5657dd65771f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [upsertAttributes](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md) - -## SavedObjectsIncrementCounterOptions.upsertAttributes property - -Attributes to use when upserting the document if it doesn't exist. - -Signature: - -```typescript -upsertAttributes?: Attributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md deleted file mode 100644 index ade286c8951d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) - -## SavedObjectsMappingProperties interface - -Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md). - -Signature: - -```typescript -export interface SavedObjectsMappingProperties -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md deleted file mode 100644 index 3c69d11880763..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) - -## SavedObjectsMigrationLogger.debug property - -Signature: - -```typescript -debug: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md deleted file mode 100644 index 16fbc8f4eaea3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) - -## SavedObjectsMigrationLogger.error property - -Signature: - -```typescript -error: (msg: string, meta: Meta) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md deleted file mode 100644 index 0dcb6b8889d4c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) - -## SavedObjectsMigrationLogger.info property - -Signature: - -```typescript -info: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md deleted file mode 100644 index 80f332c395159..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) - -## SavedObjectsMigrationLogger interface - - -Signature: - -```typescript -export interface SavedObjectsMigrationLogger -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) | (msg: string) => void | | -| [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) | <Meta extends LogMeta = LogMeta>(msg: string, meta: Meta) => void | | -| [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) | (msg: string) => void | | -| [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) | (msg: string) => void | | -| [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) | (msg: string) => void | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md deleted file mode 100644 index 34886e82d6d3d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) - -## SavedObjectsMigrationLogger.warn property - -Signature: - -```typescript -warn: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md deleted file mode 100644 index 5c37ce5aabcce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) - -## SavedObjectsMigrationLogger.warning property - -> Warning: This API is now obsolete. -> -> Use `warn` instead. 8.8.0 -> - -Signature: - -```typescript -warning: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md deleted file mode 100644 index 2241e71e4f8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) - -## SavedObjectsMigrationVersion interface - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -export interface SavedObjectsMigrationVersion -``` - -## Example - -migrationVersion: { dashboard: '7.1.1', space: '6.6.6', } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md deleted file mode 100644 index 01a712aa89aa9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsNamespaceType](./kibana-plugin-core-server.savedobjectsnamespacetype.md) - -## SavedObjectsNamespaceType type - -The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. - -Signature: - -```typescript -export declare type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md deleted file mode 100644 index 57752318cb96a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [keepAlive](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) - -## SavedObjectsOpenPointInTimeOptions.keepAlive property - -Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. - -Signature: - -```typescript -keepAlive?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md deleted file mode 100644 index 331fb6cbe0a6e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) - -## SavedObjectsOpenPointInTimeOptions interface - - -Signature: - -```typescript -export interface SavedObjectsOpenPointInTimeOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [keepAlive?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) | string | (Optional) Optionally specify how long ES should keep the PIT alive until the next request. Defaults to 5m. | -| [namespaces?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) | string\[\] | (Optional) An optional list of namespaces to be used when opening the PIT.When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - ['*'] will search across all available spaces | -| [preference?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md deleted file mode 100644 index 06fb7519d52c2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) - -## SavedObjectsOpenPointInTimeOptions.namespaces property - -An optional list of namespaces to be used when opening the PIT. - -When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - `['*']` will search across all available spaces - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md deleted file mode 100644 index 7a9f3a49e8663..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [preference](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) - -## SavedObjectsOpenPointInTimeOptions.preference property - -An optional ES preference value to be used for the query. - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md deleted file mode 100644 index 66387e5b3b89f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) > [id](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md) - -## SavedObjectsOpenPointInTimeResponse.id property - -PIT ID returned from ES. - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md deleted file mode 100644 index e3804d63a1e6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) - -## SavedObjectsOpenPointInTimeResponse interface - - -Signature: - -```typescript -export interface SavedObjectsOpenPointInTimeResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md) | string | PIT ID returned from ES. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md deleted file mode 100644 index cb4d4a65727d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) > [id](./kibana-plugin-core-server.savedobjectspitparams.id.md) - -## SavedObjectsPitParams.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md deleted file mode 100644 index 1011a908f210a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) > [keepAlive](./kibana-plugin-core-server.savedobjectspitparams.keepalive.md) - -## SavedObjectsPitParams.keepAlive property - -Signature: - -```typescript -keepAlive?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md deleted file mode 100644 index 3109a6bd88f7e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) - -## SavedObjectsPitParams interface - - -Signature: - -```typescript -export interface SavedObjectsPitParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectspitparams.id.md) | string | | -| [keepAlive?](./kibana-plugin-core-server.savedobjectspitparams.keepalive.md) | string | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md deleted file mode 100644 index 498069d4af471..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_id](./kibana-plugin-core-server.savedobjectsrawdoc._id.md) - -## SavedObjectsRawDoc.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md deleted file mode 100644 index 6dc2eeb8a0c4c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_primary\_term](./kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md) - -## SavedObjectsRawDoc.\_primary\_term property - -Signature: - -```typescript -_primary_term?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md deleted file mode 100644 index 8b7016df7492b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_seq\_no](./kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md) - -## SavedObjectsRawDoc.\_seq\_no property - -Signature: - -```typescript -_seq_no?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md deleted file mode 100644 index 44faad2c8f990..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_source](./kibana-plugin-core-server.savedobjectsrawdoc._source.md) - -## SavedObjectsRawDoc.\_source property - -Signature: - -```typescript -_source: SavedObjectsRawDocSource; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md deleted file mode 100644 index 8bce7fac941af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) - -## SavedObjectsRawDoc interface - -A raw document as represented directly in the saved object index. - -Signature: - -```typescript -export interface SavedObjectsRawDoc -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.savedobjectsrawdoc._id.md) | string | | -| [\_primary\_term?](./kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md) | number | (Optional) | -| [\_seq\_no?](./kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md) | number | (Optional) | -| [\_source](./kibana-plugin-core-server.savedobjectsrawdoc._source.md) | SavedObjectsRawDocSource | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md deleted file mode 100644 index dc2166258d0c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) - -## SavedObjectsRawDocParseOptions interface - -Options that can be specified when using the saved objects serializer to parse a raw document. - -Signature: - -```typescript -export interface SavedObjectsRawDocParseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespaceTreatment?](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md) | 'strict' \| 'lax' | (Optional) Optional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously single-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade migrations.If not specified, the default treatment is strict. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md deleted file mode 100644 index c315d78aaf417..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) > [namespaceTreatment](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md) - -## SavedObjectsRawDocParseOptions.namespaceTreatment property - -Optional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously single-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade migrations. - -If not specified, the default treatment is `strict`. - -Signature: - -```typescript -namespaceTreatment?: 'strict' | 'lax'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md deleted file mode 100644 index c10f74297305d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) - -## SavedObjectsRemoveReferencesToOptions interface - - -Signature: - -```typescript -export interface SavedObjectsRemoveReferencesToOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md) | boolean | (Optional) The Elasticsearch Refresh setting for this operation. Defaults to true | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md deleted file mode 100644 index 71e924a8af5e1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md) - -## SavedObjectsRemoveReferencesToOptions.refresh property - -The Elasticsearch Refresh setting for this operation. Defaults to `true` - -Signature: - -```typescript -refresh?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md deleted file mode 100644 index cd10a9f916b03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) - -## SavedObjectsRemoveReferencesToResponse interface - - -Signature: - -```typescript -export interface SavedObjectsRemoveReferencesToResponse extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [updated](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md) | number | The number of objects that have been updated by this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md deleted file mode 100644 index 67c3721ccdc68..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) > [updated](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md) - -## SavedObjectsRemoveReferencesToResponse.updated property - -The number of objects that have been updated by this operation - -Signature: - -```typescript -updated: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md deleted file mode 100644 index e71a9d266a3db..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkCreate](./kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md) - -## SavedObjectsRepository.bulkCreate() method - -Creates multiple documents at once - -Signature: - -```typescript -bulkCreate(objects: Array>, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkCreateObject<T>> | \[{ type, id, attributes, references, migrationVersion }\] | -| options | SavedObjectsCreateOptions | {boolean} \[options.overwrite=false\] - overwrites existing documents {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -{promise} - {saved\_objects: \[\[{ id, type, version, references, attributes, error: { message } }\]} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md deleted file mode 100644 index ab265132d606f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkGet](./kibana-plugin-core-server.savedobjectsrepository.bulkget.md) - -## SavedObjectsRepository.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkGetObject\[\] | an array of objects containing id, type and optionally fields | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -{promise} - { saved\_objects: \[{ id, type, version, attributes }\] } - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md deleted file mode 100644 index a67521753892d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkResolve](./kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md) - -## SavedObjectsRepository.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: SavedObjectsBulkResolveObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkResolveObject\[\] | an array of objects containing id, type | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -{promise} - { resolved\_objects: \[{ saved\_object, outcome }\] } - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md deleted file mode 100644 index c4244a8e34e3c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkUpdate](./kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md) - -## SavedObjectsRepository.bulkUpdate() method - -Updates multiple objects in bulk - -Signature: - -```typescript -bulkUpdate(objects: Array>, options?: SavedObjectsBulkUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkUpdateObject<T>> | \[{ type, id, attributes, options: { version, namespace } references }\] {string} options.version - ensures version matches that of persisted object {string} \[options.namespace\] | -| options | SavedObjectsBulkUpdateOptions | | - -Returns: - -Promise<SavedObjectsBulkUpdateResponse<T>> - -{promise} - {saved\_objects: \[\[{ id, type, version, references, attributes, error: { message } }\]} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md deleted file mode 100644 index 48adf6a2dba4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [checkConflicts](./kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md) - -## SavedObjectsRepository.checkConflicts() method - -Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. - -Signature: - -```typescript -checkConflicts(objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCheckConflictsObject\[\] | | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsCheckConflictsResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md deleted file mode 100644 index e25cd9dfcaae7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [closePointInTime](./kibana-plugin-core-server.savedobjectsrepository.closepointintime.md) - -## SavedObjectsRepository.closePointInTime() method - -Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using `openPointInTimeForType`. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. - -Signature: - -```typescript -closePointInTime(id: string, options?: SavedObjectsClosePointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | -| options | SavedObjectsClosePointInTimeOptions | [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) | - -Returns: - -Promise<SavedObjectsClosePointInTimeResponse> - -{promise} - [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) - -## Remarks - -While the `keepAlive` that is provided will cause a PIT to automatically close, it is highly recommended to explicitly close a PIT when you are done with it in order to avoid consuming unneeded resources in Elasticsearch. - -## Example - - -```ts -const repository = coreStart.savedObjects.createInternalRepository(); - -const { id } = await repository.openPointInTimeForType( - type: 'index-pattern', - { keepAlive: '2m' }, -); - -const response = await repository.find({ - type: 'index-pattern', - search: 'foo*', - sortField: 'name', - sortOrder: 'desc', - pit: { - id: 'abc123', - keepAlive: '2m', - }, - searchAfter: [1234, 'abcd'], -}); - -await repository.closePointInTime(response.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md deleted file mode 100644 index b22b3bd8c0b53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [collectMultiNamespaceReferences](./kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md) - -## SavedObjectsRepository.collectMultiNamespaceReferences() method - -Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace type. - -Signature: - -```typescript -collectMultiNamespaceReferences(objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCollectMultiNamespaceReferencesObject\[\] | The objects to get the references for. | -| options | SavedObjectsCollectMultiNamespaceReferencesOptions | | - -Returns: - -Promise<import("./collect\_multi\_namespace\_references").SavedObjectsCollectMultiNamespaceReferencesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md deleted file mode 100644 index 0c5412e2cd2df..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [create](./kibana-plugin-core-server.savedobjectsrepository.create.md) - -## SavedObjectsRepository.create() method - -Persists an object - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | {string} \[options.id\] - force id on creation, not recommended {boolean} \[options.overwrite=false\] {object} \[options.migrationVersion=undefined\] {string} \[options.namespace\] {array} \[options.references=\[\]\] - \[{ name, type, id }\] | - -Returns: - -Promise<SavedObject<T>> - -{promise} - { id, type, version, attributes } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md deleted file mode 100644 index 4cbf51b85f26d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [createPointInTimeFinder](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) - -## SavedObjectsRepository.createPointInTimeFinder() method - -Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any `find` queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client. - -Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments. - -This generator wraps calls to [SavedObjectsRepository.find()](./kibana-plugin-core-server.savedobjectsrepository.find.md) and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage`. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -createPointInTimeFinder(findOptions: SavedObjectsCreatePointInTimeFinderOptions, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies): ISavedObjectsPointInTimeFinder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| findOptions | SavedObjectsCreatePointInTimeFinderOptions | | -| dependencies | SavedObjectsCreatePointInTimeFinderDependencies | | - -Returns: - -ISavedObjectsPointInTimeFinder<T, A> - -## Example - - -```ts -const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - type: 'visualization', - search: 'foo*', - perPage: 100, -}; - -const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - -const responses: SavedObjectFindResponse[] = []; -for await (const response of finder.find()) { - responses.push(...response); - if (doneSearching) { - await finder.close(); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md deleted file mode 100644 index 2caa59210b9d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [delete](./kibana-plugin-core-server.savedobjectsrepository.delete.md) - -## SavedObjectsRepository.delete() method - -Deletes an object - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | {string} \[options.namespace\] | - -Returns: - -Promise<{}> - -{promise} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md deleted file mode 100644 index 2e9048bcbe188..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [deleteByNamespace](./kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md) - -## SavedObjectsRepository.deleteByNamespace() method - -Deletes all objects from the provided namespace. - -Signature: - -```typescript -deleteByNamespace(namespace: string, options?: SavedObjectsDeleteByNamespaceOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string | | -| options | SavedObjectsDeleteByNamespaceOptions | | - -Returns: - -Promise<any> - -{promise} - { took, timed\_out, total, deleted, batches, version\_conflicts, noops, retries, failures } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md deleted file mode 100644 index 58c14917aa2c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [find](./kibana-plugin-core-server.savedobjectsrepository.find.md) - -## SavedObjectsRepository.find() method - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | {(string\|Array)} \[options.type\] {string} \[options.search\] {string} \[options.defaultSearchOperator\] {Array} \[options.searchFields\] - see Elasticsearch Simple Query String Query field argument for more information {integer} \[options.page=1\] {integer} \[options.perPage=20\] {Array} \[options.searchAfter\] {string} \[options.sortField\] {string} \[options.sortOrder\] {Array} \[options.fields\] {string} \[options.namespace\] {object} \[options.hasReference\] - { type, id } {string} \[options.pit\] {string} \[options.preference\] | - -Returns: - -Promise<SavedObjectsFindResponse<T, A>> - -{promise} - { saved\_objects: \[{ id, type, version, attributes }\], total, per\_page, page } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md deleted file mode 100644 index 9f2b1b924857b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [get](./kibana-plugin-core-server.savedobjectsrepository.get.md) - -## SavedObjectsRepository.get() method - -Gets a single object - -Signature: - -```typescript -get(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObject<T>> - -{promise} - { id, type, version, attributes } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md deleted file mode 100644 index 0a51ec9429fe9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md +++ /dev/null @@ -1,69 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [incrementCounter](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) - -## SavedObjectsRepository.incrementCounter() method - -Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id. - -Signature: - -```typescript -incrementCounter(type: string, id: string, counterFields: Array, options?: SavedObjectsIncrementCounterOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of saved object whose fields should be incremented | -| id | string | The id of the document whose fields should be incremented | -| counterFields | Array<string \| SavedObjectsIncrementCounterField> | An array of field names to increment or an array of [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) | -| options | SavedObjectsIncrementCounterOptions<T> | [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) | - -Returns: - -Promise<SavedObject<T>> - -The saved object after the specified fields were incremented - -## Remarks - -When supplying a field name like `stats.api.counter` the field name will be used as-is to create a document like: `{attributes: {'stats.api.counter': 1}}` It will not create a nested structure like: `{attributes: {stats: {api: {counter: 1}}}}` - -When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/main/src/plugins/usage\_collection/README.mdx\#tracking-interactions-with-incrementcounter) - -## Example - - -```ts -const repository = coreStart.savedObjects.createInternalRepository(); - -// Initialize all fields to 0 -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - 'stats.apiCalls', - 'stats.sampleDataInstalled', - ], {initialize: true}); - -// Increment the apiCalls field counter -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - 'stats.apiCalls', - ]) - -// Increment the apiCalls field counter by 4 -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - { fieldName: 'stats.apiCalls' incrementBy: 4 }, - ]) - -// Initialize the document with arbitrary fields if not present -repository.incrementCounter<{ appId: string }>( - 'dashboard_counter_type', - 'counter_id', - [ 'stats.apiCalls'], - { upsertAttributes: { appId: 'myId' } } -) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md deleted file mode 100644 index b1d65f5f6d3c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) - -## SavedObjectsRepository class - - -Signature: - -```typescript -export declare class SavedObjectsRepository -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md) | | Creates multiple documents at once | -| [bulkGet(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkget.md) | | Returns an array of objects by id | -| [bulkResolve(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md) | | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md) | | Updates multiple objects in bulk | -| [checkConflicts(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md) | | Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. | -| [closePointInTime(id, options)](./kibana-plugin-core-server.savedobjectsrepository.closepointintime.md) | | Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using openPointInTimeForType.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. | -| [collectMultiNamespaceReferences(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md) | | Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace type. | -| [create(type, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.create.md) | | Persists an object | -| [createPointInTimeFinder(findOptions, dependencies)](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) | | Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any find queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client.Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments.This generator wraps calls to [SavedObjectsRepository.find()](./kibana-plugin-core-server.savedobjectsrepository.find.md) and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [delete(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.delete.md) | | Deletes an object | -| [deleteByNamespace(namespace, options)](./kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md) | | Deletes all objects from the provided namespace. | -| [find(options)](./kibana-plugin-core-server.savedobjectsrepository.find.md) | | | -| [get(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.get.md) | | Gets a single object | -| [incrementCounter(type, id, counterFields, options)](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) | | Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id. | -| [openPointInTimeForType(type, { keepAlive, preference })](./kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md) | | Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned id can then be passed to SavedObjects.find to search against that PIT.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. | -| [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md) | | Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. | -| [resolve(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.resolve.md) | | Resolves a single object, using any legacy URL alias if it exists | -| [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.update.md) | | Updates an object | -| [updateObjectsSpaces(objects, spacesToAdd, spacesToRemove, options)](./kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md) | | Updates one or more objects to add and/or remove them from specified spaces. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md deleted file mode 100644 index e0eb4bc603a2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [openPointInTimeForType](./kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md) - -## SavedObjectsRepository.openPointInTimeForType() method - -Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned `id` can then be passed to `SavedObjects.find` to search against that PIT. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. - -Signature: - -```typescript -openPointInTimeForType(type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| string\[\] | | -| { keepAlive, preference } | SavedObjectsOpenPointInTimeOptions | | - -Returns: - -Promise<SavedObjectsOpenPointInTimeResponse> - -{promise} - { id: string } - -## Example - - -```ts -const { id } = await savedObjectsClient.openPointInTimeForType( - type: 'visualization', - { keepAlive: '5m' }, -); -const page1 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id, keepAlive: '2m' }, -}); -const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; -const page2 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id: page1.pit_id }, - searchAfter: lastHit.sort, -}); -await savedObjectsClient.closePointInTime(page2.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md deleted file mode 100644 index 6691bf69e58dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [removeReferencesTo](./kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md) - -## SavedObjectsRepository.removeReferencesTo() method - -Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - -Signature: - -```typescript -removeReferencesTo(type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsRemoveReferencesToOptions | | - -Returns: - -Promise<SavedObjectsRemoveReferencesToResponse> - -## Remarks - -Will throw a conflict error if the `update_by_query` operation returns any failure. In that case some references might have been removed, and some were not. It is the caller's responsibility to handle and fix this situation if it was to happen. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md deleted file mode 100644 index bf558eca975fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [resolve](./kibana-plugin-core-server.savedobjectsrepository.resolve.md) - -## SavedObjectsRepository.resolve() method - -Resolves a single object, using any legacy URL alias if it exists - -Signature: - -```typescript -resolve(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsResolveResponse<T>> - -{promise} - { saved\_object, outcome } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md deleted file mode 100644 index 681ba9eb3f014..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [update](./kibana-plugin-core-server.savedobjectsrepository.update.md) - -## SavedObjectsRepository.update() method - -Updates an object - -Signature: - -```typescript -update(type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | Partial<T> | | -| options | SavedObjectsUpdateOptions<T> | {string} options.version - ensures version matches that of persisted object {string} \[options.namespace\] {array} \[options.references\] - \[{ name, type, id }\] | - -Returns: - -Promise<SavedObjectsUpdateResponse<T>> - -{promise} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md deleted file mode 100644 index c226e8d2d2b1d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [updateObjectsSpaces](./kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md) - -## SavedObjectsRepository.updateObjectsSpaces() method - -Updates one or more objects to add and/or remove them from specified spaces. - -Signature: - -```typescript -updateObjectsSpaces(objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsUpdateObjectsSpacesObject\[\] | | -| spacesToAdd | string\[\] | | -| spacesToRemove | string\[\] | | -| options | SavedObjectsUpdateObjectsSpacesOptions | | - -Returns: - -Promise<import("./update\_objects\_spaces").SavedObjectsUpdateObjectsSpacesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md deleted file mode 100644 index e39ce020b930c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) > [createInternalRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md) - -## SavedObjectsRepositoryFactory.createInternalRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. - -Signature: - -```typescript -createInternalRepository: (includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md deleted file mode 100644 index 9cd0df9094277..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) > [createScopedRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md) - -## SavedObjectsRepositoryFactory.createScopedRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. - -Signature: - -```typescript -createScopedRepository: (req: KibanaRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md deleted file mode 100644 index 72aa79ed4df29..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) - -## SavedObjectsRepositoryFactory interface - -Factory provided when invoking a [client factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) - -Signature: - -```typescript -export interface SavedObjectsRepositoryFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createInternalRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md) | (includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. | -| [createScopedRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md) | (req: KibanaRequest, includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md deleted file mode 100644 index 82831eae37d7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [createNewCopies](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md) - -## SavedObjectsResolveImportErrorsOptions.createNewCopies property - -If true, will create new copies of import objects, each with a random `id` and undefined `originId`. - -Signature: - -```typescript -createNewCopies: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md deleted file mode 100644 index 7a005db4334ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) - -## SavedObjectsResolveImportErrorsOptions interface - -Options to control the "resolve import" operation. - -Signature: - -```typescript -export interface SavedObjectsResolveImportErrorsOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopies](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md) | boolean | If true, will create new copies of import objects, each with a random id and undefined originId. | -| [namespace?](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md) | string | (Optional) if specified, will import in given namespace | -| [readStream](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to resolve errors from | -| [retries](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md) | SavedObjectsImportRetry\[\] | saved object import references to retry | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md deleted file mode 100644 index 0ab9e02f9dfe5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md) - -## SavedObjectsResolveImportErrorsOptions.namespace property - -if specified, will import in given namespace - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md deleted file mode 100644 index 8f5aa9bad3747..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [readStream](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md) - -## SavedObjectsResolveImportErrorsOptions.readStream property - -The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to resolve errors from - -Signature: - -```typescript -readStream: Readable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md deleted file mode 100644 index 78b8cfdb72e3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [retries](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md) - -## SavedObjectsResolveImportErrorsOptions.retries property - -saved object import references to retry - -Signature: - -```typescript -retries: SavedObjectsImportRetry[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md deleted file mode 100644 index afad46f9a84cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [alias\_purpose](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md) - -## SavedObjectsResolveResponse.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md deleted file mode 100644 index 52419918c0831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [alias\_target\_id](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md) - -## SavedObjectsResolveResponse.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md deleted file mode 100644 index 0228c624f69d0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) - -## SavedObjectsResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md) | 'savedObjectConversion' \| 'savedObjectImport' | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md) | string | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md) | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md) | SavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md deleted file mode 100644 index eadd85b175375..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [outcome](./kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md) - -## SavedObjectsResolveResponse.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md deleted file mode 100644 index c7748a2f97025..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [saved\_object](./kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md) - -## SavedObjectsResolveResponse.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SavedObject; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md deleted file mode 100644 index 6172a05d5c8fa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [generateRawId](./kibana-plugin-core-server.savedobjectsserializer.generaterawid.md) - -## SavedObjectsSerializer.generateRawId() method - -Given a saved object type and id, generates the compound id that is stored in the raw document. - -Signature: - -```typescript -generateRawId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object | -| type | string | The saved object type | -| id | string | The id of the saved object | - -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md deleted file mode 100644 index 0f7c3dc22faf1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [generateRawLegacyUrlAliasId](./kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md) - -## SavedObjectsSerializer.generateRawLegacyUrlAliasId() method - -Given a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias. - -Signature: - -```typescript -generateRawLegacyUrlAliasId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object | -| type | string | The saved object type | -| id | string | The id of the saved object | - -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md deleted file mode 100644 index 00963e353aa20..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [isRawSavedObject](./kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md) - -## SavedObjectsSerializer.isRawSavedObject() method - -Determines whether or not the raw document can be converted to a saved object. - -Signature: - -```typescript -isRawSavedObject(doc: SavedObjectsRawDoc, options?: SavedObjectsRawDocParseOptions): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| doc | SavedObjectsRawDoc | The raw ES document to be tested | -| options | SavedObjectsRawDocParseOptions | Options for parsing the raw document. | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md deleted file mode 100644 index c7fa5fc85c613..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) - -## SavedObjectsSerializer class - -A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. - -Signature: - -```typescript -export declare class SavedObjectsSerializer -``` - -## Remarks - -Serializer instances should only be created and accessed by calling [SavedObjectsServiceStart.createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsSerializer` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [generateRawId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsserializer.generaterawid.md) | | Given a saved object type and id, generates the compound id that is stored in the raw document. | -| [generateRawLegacyUrlAliasId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md) | | Given a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias. | -| [isRawSavedObject(doc, options)](./kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md) | | Determines whether or not the raw document can be converted to a saved object. | -| [rawToSavedObject(doc, options)](./kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md) | | Converts a document from the format that is stored in elasticsearch to the saved object client format. | -| [savedObjectToRaw(savedObj)](./kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md) | | Converts a document from the saved object client format to the format that is stored in elasticsearch. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md deleted file mode 100644 index 9ac0ae0feee09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [rawToSavedObject](./kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md) - -## SavedObjectsSerializer.rawToSavedObject() method - -Converts a document from the format that is stored in elasticsearch to the saved object client format. - -Signature: - -```typescript -rawToSavedObject(doc: SavedObjectsRawDoc, options?: SavedObjectsRawDocParseOptions): SavedObjectSanitizedDoc; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| doc | SavedObjectsRawDoc | The raw ES document to be converted to saved object format. | -| options | SavedObjectsRawDocParseOptions | Options for parsing the raw document. | - -Returns: - -SavedObjectSanitizedDoc<T> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md deleted file mode 100644 index 560011fc09638..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [savedObjectToRaw](./kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md) - -## SavedObjectsSerializer.savedObjectToRaw() method - -Converts a document from the saved object client format to the format that is stored in elasticsearch. - -Signature: - -```typescript -savedObjectToRaw(savedObj: SavedObjectSanitizedDoc): SavedObjectsRawDoc; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| savedObj | SavedObjectSanitizedDoc | The saved object to be converted to raw ES format. | - -Returns: - -SavedObjectsRawDoc - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md deleted file mode 100644 index 1c2a15a8b322e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [addClientWrapper](./kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) - -## SavedObjectsServiceSetup.addClientWrapper property - -Add a [client wrapper factory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) with the given priority. - -Signature: - -```typescript -addClientWrapper: (priority: number, id: string, factory: SavedObjectsClientWrapperFactory) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md deleted file mode 100644 index 9319ae987ad44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [getKibanaIndex](./kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md) - -## SavedObjectsServiceSetup.getKibanaIndex property - -Returns the default index used for saved objects. - -Signature: - -```typescript -getKibanaIndex: () => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md deleted file mode 100644 index d9f7b888338fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md +++ /dev/null @@ -1,56 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) - -## SavedObjectsServiceSetup interface - -Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. - -Signature: - -```typescript -export interface SavedObjectsServiceSetup -``` - -## Remarks - -When plugins access the Saved Objects client, a new client is created using the factory provided to `setClientFactory` and wrapped by all wrappers registered through `addClientWrapper`. - -## Example 1 - - -```ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.setClientFactory(({ request: KibanaRequest }) => { - return new SavedObjectsClient(core.savedObjects.scopedRepository(request)); - }) - } -} -``` - -## Example 2 - - -```ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; -import { mySoType } from './saved_objects' - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType(mySoType); - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addClientWrapper](./kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) | (priority: number, id: string, factory: SavedObjectsClientWrapperFactory) => void | Add a [client wrapper factory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) with the given priority. | -| [getKibanaIndex](./kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md) | () => string | Returns the default index used for saved objects. | -| [registerType](./kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | <Attributes extends SavedObjectAttributes = any>(type: SavedObjectsType<Attributes>) => void | Register a [savedObjects type](./kibana-plugin-core-server.savedobjectstype.md) definition.See the [mappings format](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-core-server.savedobjectmigrationmap.md) for more details about these. | -| [setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | (clientFactoryProvider: SavedObjectsClientFactoryProvider) => void | Set the default [factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) for creating Saved Objects clients. Only one provider can be set, subsequent calls to this method will fail. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md deleted file mode 100644 index afe3098ef1813..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md +++ /dev/null @@ -1,60 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [registerType](./kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) - -## SavedObjectsServiceSetup.registerType property - -Register a [savedObjects type](./kibana-plugin-core-server.savedobjectstype.md) definition. - -See the [mappings format](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-core-server.savedobjectmigrationmap.md) for more details about these. - -Signature: - -```typescript -registerType: (type: SavedObjectsType) => void; -``` - -## Example - - -```ts -// src/plugins/my_plugin/server/saved_objects/my_type.ts -import { SavedObjectsType } from 'src/core/server'; -import * as migrations from './migrations'; -import * as schemas from './schemas'; - -export const myType: SavedObjectsType = { - name: 'MyType', - hidden: false, - namespaceType: 'multiple', - mappings: { - properties: { - textField: { - type: 'text', - }, - boolField: { - type: 'boolean', - }, - }, - }, - migrations: { - '2.0.0': migrations.migrateToV2, - '2.1.0': migrations.migrateToV2_1 - }, - schemas: { - '2.0.0': schemas.v2, - '2.1.0': schemas.v2_1, - }, -}; - -// src/plugins/my_plugin/server/plugin.ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType(myType); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md deleted file mode 100644 index e098245e369f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) - -## SavedObjectsServiceSetup.setClientFactoryProvider property - -Set the default [factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) for creating Saved Objects clients. Only one provider can be set, subsequent calls to this method will fail. - -Signature: - -```typescript -setClientFactoryProvider: (clientFactoryProvider: SavedObjectsClientFactoryProvider) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md deleted file mode 100644 index 273d80983f15d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createExporter](./kibana-plugin-core-server.savedobjectsservicestart.createexporter.md) - -## SavedObjectsServiceStart.createExporter property - -Creates an [exporter](./kibana-plugin-core-server.isavedobjectsexporter.md) bound to given client. - -Signature: - -```typescript -createExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md deleted file mode 100644 index f2617c5c6c12a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createImporter](./kibana-plugin-core-server.savedobjectsservicestart.createimporter.md) - -## SavedObjectsServiceStart.createImporter property - -Creates an [importer](./kibana-plugin-core-server.isavedobjectsimporter.md) bound to given client. - -Signature: - -```typescript -createImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md deleted file mode 100644 index d03e9ca223c53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md) - -## SavedObjectsServiceStart.createInternalRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. - -Signature: - -```typescript -createInternalRepository: (includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md deleted file mode 100644 index 762f77b98e74d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createScopedRepository](./kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md) - -## SavedObjectsServiceStart.createScopedRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. - -Signature: - -```typescript -createScopedRepository: (req: KibanaRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` - -## Remarks - -Prefer using `getScopedClient`. This should only be used when using methods not exposed on [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md deleted file mode 100644 index 434d6a0270ca3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) - -## SavedObjectsServiceStart.createSerializer property - -Creates a [serializer](./kibana-plugin-core-server.savedobjectsserializer.md) that is aware of all registered types. - -Signature: - -```typescript -createSerializer: () => SavedObjectsSerializer; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md deleted file mode 100644 index e4d3129ece549..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [getScopedClient](./kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) - -## SavedObjectsServiceStart.getScopedClient property - -Creates a [Saved Objects client](./kibana-plugin-core-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client. - -A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md). - -Signature: - -```typescript -getScopedClient: (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md deleted file mode 100644 index aac2f89b545d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [getTypeRegistry](./kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md) - -## SavedObjectsServiceStart.getTypeRegistry property - -Returns the [registry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md) - -Signature: - -```typescript -getTypeRegistry: () => ISavedObjectTypeRegistry; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md deleted file mode 100644 index ae7480ab1e65b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) - -## SavedObjectsServiceStart interface - -Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. - -Signature: - -```typescript -export interface SavedObjectsServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createExporter](./kibana-plugin-core-server.savedobjectsservicestart.createexporter.md) | (client: SavedObjectsClientContract) => ISavedObjectsExporter | Creates an [exporter](./kibana-plugin-core-server.isavedobjectsexporter.md) bound to given client. | -| [createImporter](./kibana-plugin-core-server.savedobjectsservicestart.createimporter.md) | (client: SavedObjectsClientContract) => ISavedObjectsImporter | Creates an [importer](./kibana-plugin-core-server.isavedobjectsimporter.md) bound to given client. | -| [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md) | (includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. | -| [createScopedRepository](./kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md) | (req: KibanaRequest, includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. | -| [createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) | () => SavedObjectsSerializer | Creates a [serializer](./kibana-plugin-core-server.savedobjectsserializer.md) that is aware of all registered types. | -| [getScopedClient](./kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) | (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract | Creates a [Saved Objects client](./kibana-plugin-core-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client.A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md). | -| [getTypeRegistry](./kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md) | () => ISavedObjectTypeRegistry | Returns the [registry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md deleted file mode 100644 index 890ed36535b3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) - -## SavedObjectStatusMeta interface - -Meta information about the SavedObjectService's status. Available to plugins via [CoreSetup.status](./kibana-plugin-core-server.coresetup.status.md). - -Signature: - -```typescript -export interface SavedObjectStatusMeta -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [migratedIndices](./kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md) | { \[status: string\]: number; skipped: number; migrated: number; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md deleted file mode 100644 index 6a29623b2f122..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) > [migratedIndices](./kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md) - -## SavedObjectStatusMeta.migratedIndices property - -Signature: - -```typescript -migratedIndices: { - [status: string]: number; - skipped: number; - migrated: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md deleted file mode 100644 index 296f7ba3044f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [convertToAliasScript](./kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md) - -## SavedObjectsType.convertToAliasScript property - -If defined, will be used to convert the type to an alias. - -Signature: - -```typescript -convertToAliasScript?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md deleted file mode 100644 index a3fac34153633..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [convertToMultiNamespaceTypeVersion](./kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md) - -## SavedObjectsType.convertToMultiNamespaceTypeVersion property - -If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this version. - -Requirements: - -1. This string value must be a valid semver version 2. This type must have previously specified [\`namespaceType: 'single'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) 3. This type must also specify [\`namespaceType: 'multiple'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) \*or\* [\`namespaceType: 'multiple-isolated'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) - -Example of a single-namespace type in 7.12: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'single', - mappings: {...} -} -``` -Example after converting to a multi-namespace (isolated) type in 8.0: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple-isolated', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Example after converting to a multi-namespace (shareable) type in 8.1: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. - -Signature: - -```typescript -convertToMultiNamespaceTypeVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md deleted file mode 100644 index f5446b37dc29c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [excludeOnUpgrade](./kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md) - -## SavedObjectsType.excludeOnUpgrade property - -If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. See [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) for more details. - -Signature: - -```typescript -excludeOnUpgrade?: SavedObjectTypeExcludeFromUpgradeFilterHook; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md deleted file mode 100644 index d13b9177394d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [hidden](./kibana-plugin-core-server.savedobjectstype.hidden.md) - -## SavedObjectsType.hidden property - -Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an `extraType` when creating the repository. - -See [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md). - -Signature: - -```typescript -hidden: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md deleted file mode 100644 index 8db74b9bfdec4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [indexPattern](./kibana-plugin-core-server.savedobjectstype.indexpattern.md) - -## SavedObjectsType.indexPattern property - -If defined, the type instances will be stored in the given index instead of the default one. - -Signature: - -```typescript -indexPattern?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md deleted file mode 100644 index d98c553656b1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [management](./kibana-plugin-core-server.savedobjectstype.management.md) - -## SavedObjectsType.management property - -An optional [saved objects management section](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) definition for the type. - -Signature: - -```typescript -management?: SavedObjectsTypeManagementDefinition; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md deleted file mode 100644 index 066561b8c8633..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) - -## SavedObjectsType.mappings property - -The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. - -Signature: - -```typescript -mappings: SavedObjectsTypeMappingDefinition; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md deleted file mode 100644 index cd6e724685777..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) - -## SavedObjectsType interface - - -Signature: - -```typescript -export interface SavedObjectsType -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [convertToAliasScript?](./kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md) | string | (Optional) If defined, will be used to convert the type to an alias. | -| [convertToMultiNamespaceTypeVersion?](./kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md) | string | (Optional) If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this version.Requirements:1. This string value must be a valid semver version 2. This type must have previously specified [\`namespaceType: 'single'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) 3. This type must also specify [\`namespaceType: 'multiple'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) \*or\* [\`namespaceType: 'multiple-isolated'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md)Example of a single-namespace type in 7.12: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'single', - mappings: {...} -} -``` -Example after converting to a multi-namespace (isolated) type in 8.0: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple-isolated', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Example after converting to a multi-namespace (shareable) type in 8.1: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. | -| [excludeOnUpgrade?](./kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md) | SavedObjectTypeExcludeFromUpgradeFilterHook | (Optional) If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. See [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) for more details. | -| [hidden](./kibana-plugin-core-server.savedobjectstype.hidden.md) | boolean | Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an extraType when creating the repository.See [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md). | -| [indexPattern?](./kibana-plugin-core-server.savedobjectstype.indexpattern.md) | string | (Optional) If defined, the type instances will be stored in the given index instead of the default one. | -| [management?](./kibana-plugin-core-server.savedobjectstype.management.md) | SavedObjectsTypeManagementDefinition<Attributes> | (Optional) An optional [saved objects management section](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) definition for the type. | -| [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) | SavedObjectsTypeMappingDefinition | The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. | -| [migrations?](./kibana-plugin-core-server.savedobjectstype.migrations.md) | SavedObjectMigrationMap \| (() => SavedObjectMigrationMap) | (Optional) An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) or a function returning a map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. | -| [name](./kibana-plugin-core-server.savedobjectstype.name.md) | string | The name of the type, which is also used as the internal id. | -| [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) | SavedObjectsNamespaceType | The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. | -| [schemas?](./kibana-plugin-core-server.savedobjectstype.schemas.md) | SavedObjectsValidationMap \| (() => SavedObjectsValidationMap) | (Optional) An optional schema that can be used to validate the attributes of the type.When provided, calls to [create](./kibana-plugin-core-server.savedobjectsclient.create.md) will be validated against this schema.See [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) for more details. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md deleted file mode 100644 index 6550d48a1c26a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [migrations](./kibana-plugin-core-server.savedobjectstype.migrations.md) - -## SavedObjectsType.migrations property - -An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) or a function returning a map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. - -Signature: - -```typescript -migrations?: SavedObjectMigrationMap | (() => SavedObjectMigrationMap); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md deleted file mode 100644 index 4c63500498085..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [name](./kibana-plugin-core-server.savedobjectstype.name.md) - -## SavedObjectsType.name property - -The name of the type, which is also used as the internal id. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md deleted file mode 100644 index 3a3b0f7f3a9a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) - -## SavedObjectsType.namespaceType property - -The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. - -Signature: - -```typescript -namespaceType: SavedObjectsNamespaceType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md deleted file mode 100644 index 466d8e361f995..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [schemas](./kibana-plugin-core-server.savedobjectstype.schemas.md) - -## SavedObjectsType.schemas property - -An optional schema that can be used to validate the attributes of the type. - -When provided, calls to [create](./kibana-plugin-core-server.savedobjectsclient.create.md) will be validated against this schema. - -See [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) for more details. - -Signature: - -```typescript -schemas?: SavedObjectsValidationMap | (() => SavedObjectsValidationMap); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md deleted file mode 100644 index d922a8daaac93..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [defaultSearchField](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) - -## SavedObjectsTypeManagementDefinition.defaultSearchField property - -The default search field to use for this type. Defaults to `id`. - -Signature: - -```typescript -defaultSearchField?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md deleted file mode 100644 index 71325318a68e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [displayName](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md) - -## SavedObjectsTypeManagementDefinition.displayName property - -When specified, will be used instead of the type's name in SO management section's labels. - -Signature: - -```typescript -displayName?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md deleted file mode 100644 index 75f820d7a8e56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getEditUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md) - -## SavedObjectsTypeManagementDefinition.getEditUrl property - -Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. - -Signature: - -```typescript -getEditUrl?: (savedObject: SavedObject) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md deleted file mode 100644 index d6d50840aaadb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getInAppUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md) - -## SavedObjectsTypeManagementDefinition.getInAppUrl property - -Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. - -Signature: - -```typescript -getInAppUrl?: (savedObject: SavedObject) => { - path: string; - uiCapabilitiesPath: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md deleted file mode 100644 index 75784666ef963..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getTitle](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) - -## SavedObjectsTypeManagementDefinition.getTitle property - -Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. - -Signature: - -```typescript -getTitle?: (savedObject: SavedObject) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md deleted file mode 100644 index d4bbea50b5692..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [icon](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md) - -## SavedObjectsTypeManagementDefinition.icon property - -The eui icon name to display in the management table. If not defined, the default icon will be used. - -Signature: - -```typescript -icon?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md deleted file mode 100644 index 9300f830e105b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [importableAndExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md) - -## SavedObjectsTypeManagementDefinition.importableAndExportable property - -Is the type importable or exportable. Defaults to `false`. - -Signature: - -```typescript -importableAndExportable?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md deleted file mode 100644 index c6dff60610990..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [isExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md) - -## SavedObjectsTypeManagementDefinition.isExportable property - -Optional hook to specify whether an object should be exportable. - -If specified, `isExportable` will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export. - -When implementing both `isExportable` and `onExport`, it is mandatory that `isExportable` returns the same value for an object before and after going though the export transform. E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -Signature: - -```typescript -isExportable?: SavedObjectsExportablePredicate; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - -## Example - -Registering a type with a per-object exportability predicate - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - isExportable: (object) => { - if (object.attributes.myCustomAttr === 'foo') { - return false; - } - return true; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md deleted file mode 100644 index eeda40cd59664..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) - -## SavedObjectsTypeManagementDefinition interface - -Configuration options for the [type](./kibana-plugin-core-server.savedobjectstype.md)'s management section. - -Signature: - -```typescript -export interface SavedObjectsTypeManagementDefinition -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchField?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) | string | (Optional) The default search field to use for this type. Defaults to id. | -| [displayName?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md) | string | (Optional) When specified, will be used instead of the type's name in SO management section's labels. | -| [getEditUrl?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md) | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. | -| [getInAppUrl?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md) | (savedObject: SavedObject<Attributes>) => { path: string; uiCapabilitiesPath: string; } | (Optional) Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. | -| [getTitle?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. | -| [icon?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md) | string | (Optional) The eui icon name to display in the management table. If not defined, the default icon will be used. | -| [importableAndExportable?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md) | boolean | (Optional) Is the type importable or exportable. Defaults to false. | -| [isExportable?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md) | SavedObjectsExportablePredicate<Attributes> | (Optional) Optional hook to specify whether an object should be exportable.If specified, isExportable will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) | -| [onExport?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) | SavedObjectsExportTransform<Attributes> | (Optional) An optional export transform function that can be used transform the objects of the registered type during the export process.It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) | -| [onImport?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) | SavedObjectsImportHook<Attributes> | (Optional) An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type.Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. | -| [visibleInManagement?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md) | boolean | (Optional) When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to true. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md deleted file mode 100644 index a0d41d2d64967..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [onExport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) - -## SavedObjectsTypeManagementDefinition.onExport property - -An optional export transform function that can be used transform the objects of the registered type during the export process. - -It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list. - -See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples. - -When implementing both `isExportable` and `onExport`, it is mandatory that `isExportable` returns the same value for an object before and after going though the export transform. E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -Signature: - -```typescript -onExport?: SavedObjectsExportTransform; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md deleted file mode 100644 index c54570d79a7e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [onImport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) - -## SavedObjectsTypeManagementDefinition.onImport property - -An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type. - -Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. - -Signature: - -```typescript -onImport?: SavedObjectsImportHook; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - -## Example - -Registering a hook displaying a warning about a specific type of object - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onImport: (objects) => { - if(someActionIsNeeded(objects)) { - return { - warnings: [ - { - type: 'action_required', - message: 'Objects need to be manually enabled after import', - actionPath: '/app/my-app/require-activation', - }, - ] - } - } - return {}; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md deleted file mode 100644 index 33ddc8e8c8307..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [visibleInManagement](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md) - -## SavedObjectsTypeManagementDefinition.visibleInManagement property - -When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to `true`. - -Signature: - -```typescript -visibleInManagement?: boolean; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md deleted file mode 100644 index 70775760ac77d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) > [dynamic](./kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md) - -## SavedObjectsTypeMappingDefinition.dynamic property - -The dynamic property of the mapping, either `false` or `'strict'`. If unspecified `dynamic: 'strict'` will be inherited from the top-level index mappings. - -Signature: - -```typescript -dynamic?: false | 'strict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md deleted file mode 100644 index 7f4c82c23e2ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) - -## SavedObjectsTypeMappingDefinition interface - -Describe a saved object type mapping. - -Signature: - -```typescript -export interface SavedObjectsTypeMappingDefinition -``` - -## Example - - -```ts -const typeDefinition: SavedObjectsTypeMappingDefinition = { - properties: { - enabled: { - type: "boolean" - }, - sendUsageFrom: { - ignore_above: 256, - type: "keyword" - }, - lastReported: { - type: "date" - }, - lastVersionChecked: { - ignore_above: 256, - type: "keyword" - }, - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dynamic?](./kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md) | false \| 'strict' | (Optional) The dynamic property of the mapping, either false or 'strict'. If unspecified dynamic: 'strict' will be inherited from the top-level index mappings. | -| [properties](./kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md) | SavedObjectsMappingProperties | The underlying properties of the type mapping | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md deleted file mode 100644 index 6ccf2e2c90d0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) > [properties](./kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md) - -## SavedObjectsTypeMappingDefinition.properties property - -The underlying properties of the type mapping - -Signature: - -```typescript -properties: SavedObjectsMappingProperties; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md deleted file mode 100644 index dac110ac4f475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) > [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md) - -## SavedObjectsUpdateObjectsSpacesObject.id property - -The type of the object to update - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md deleted file mode 100644 index 6fa04623c96a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) - -## SavedObjectsUpdateObjectsSpacesObject interface - -An object that should have its spaces updated. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md) | string | The type of the object to update | -| [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md) | string | The ID of the object to update | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md deleted file mode 100644 index 2e54d1636c5e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) > [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md) - -## SavedObjectsUpdateObjectsSpacesObject.type property - -The ID of the object to update - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md deleted file mode 100644 index b8f17699b1841..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) - -## SavedObjectsUpdateObjectsSpacesOptions interface - -Options for the update operation. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md deleted file mode 100644 index 3d210f6ac51c7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md) - -## SavedObjectsUpdateObjectsSpacesOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md deleted file mode 100644 index aff67e0c54e66..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) - -## SavedObjectsUpdateObjectsSpacesResponse interface - -The response when objects' spaces are updated. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md) | SavedObjectsUpdateObjectsSpacesResponseObject\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md deleted file mode 100644 index 13328e2aed094..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) > [objects](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md) - -## SavedObjectsUpdateObjectsSpacesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectsUpdateObjectsSpacesResponseObject[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md deleted file mode 100644 index 7d7ac4ada884d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [error](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.error property - -Included if there was an error updating this object's spaces - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md deleted file mode 100644 index 28a81ee5dfd6a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md deleted file mode 100644 index 5078473e9e6bd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject interface - -Details about a specific object's update result. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesResponseObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error?](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md) | SavedObjectError | (Optional) Included if there was an error updating this object's spaces | -| [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md) | string | The ID of the referenced object | -| [spaces](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md deleted file mode 100644 index 52b1ca187925c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [spaces](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md deleted file mode 100644 index da0bbb1088507..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md deleted file mode 100644 index 7044f3007c382..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) - -## SavedObjectsUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references?](./kibana-plugin-core-server.savedobjectsupdateoptions.references.md) | SavedObjectReference\[\] | (Optional) A reference to another saved object. | -| [refresh?](./kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | -| [retryOnConflict?](./kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md) | number | (Optional) The Elasticsearch retry_on_conflict setting for this operation. Defaults to 0 when version is provided, 3 otherwise. | -| [upsert?](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md) | Attributes | (Optional) If specified, will be used to perform an upsert if the document doesn't exist | -| [version?](./kibana-plugin-core-server.savedobjectsupdateoptions.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md deleted file mode 100644 index 2cea0a7bdf0da..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [references](./kibana-plugin-core-server.savedobjectsupdateoptions.references.md) - -## SavedObjectsUpdateOptions.references property - -A reference to another saved object. - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md deleted file mode 100644 index 16ad763df46d2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md) - -## SavedObjectsUpdateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md deleted file mode 100644 index 2fc54d0fb41ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [retryOnConflict](./kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md) - -## SavedObjectsUpdateOptions.retryOnConflict property - -The Elasticsearch `retry_on_conflict` setting for this operation. Defaults to `0` when `version` is provided, `3` otherwise. - -Signature: - -```typescript -retryOnConflict?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md deleted file mode 100644 index 53b769afd0938..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [upsert](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md) - -## SavedObjectsUpdateOptions.upsert property - -If specified, will be used to perform an upsert if the document doesn't exist - -Signature: - -```typescript -upsert?: Attributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md deleted file mode 100644 index b92e517509c5c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [version](./kibana-plugin-core-server.savedobjectsupdateoptions.version.md) - -## SavedObjectsUpdateOptions.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md deleted file mode 100644 index df80e7ec56803..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) > [attributes](./kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md) - -## SavedObjectsUpdateResponse.attributes property - -Signature: - -```typescript -attributes: Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md deleted file mode 100644 index 5c773d92c6364..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) - -## SavedObjectsUpdateResponse interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateResponse extends Omit, 'attributes' | 'references'> -``` -Extends: Omit<SavedObject<T>, 'attributes' \| 'references'> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md) | Partial<T> | | -| [references](./kibana-plugin-core-server.savedobjectsupdateresponse.references.md) | SavedObjectReference\[\] \| undefined | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md deleted file mode 100644 index 262a4733e7beb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) > [references](./kibana-plugin-core-server.savedobjectsupdateresponse.references.md) - -## SavedObjectsUpdateResponse.references property - -Signature: - -```typescript -references: SavedObjectReference[] | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md deleted file mode 100644 index 23cbebf22aa21..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [createEmptyFindResponse](./kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md) - -## SavedObjectsUtils.createEmptyFindResponse property - -Creates an empty response for a find operation. This is only intended to be used by saved objects client wrappers. - -Signature: - -```typescript -static createEmptyFindResponse: ({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md deleted file mode 100644 index 887f2fb5d9fe1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [generateId](./kibana-plugin-core-server.savedobjectsutils.generateid.md) - -## SavedObjectsUtils.generateId() method - -Generates a random ID for a saved objects. - -Signature: - -```typescript -static generateId(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md deleted file mode 100644 index 502d9dcab8cf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [getConvertedObjectId](./kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md) - -## SavedObjectsUtils.getConvertedObjectId() method - -Uses a single-namespace object's "legacy ID" to determine what its new ID will be after it is converted to a multi-namespace type. - -Signature: - -```typescript -static getConvertedObjectId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object before it is converted. | -| type | string | The type of the saved object before it is converted. | -| id | string | The ID of the saved object before it is converted. | - -Returns: - -string - -{string} The ID of the saved object after it is converted. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md deleted file mode 100644 index 75db00c449654..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [isRandomId](./kibana-plugin-core-server.savedobjectsutils.israndomid.md) - -## SavedObjectsUtils.isRandomId() method - -Validates that a saved object ID has been randomly generated. - -Signature: - -```typescript -static isRandomId(id: string | undefined): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string \| undefined | The ID of a saved object. Use uuid.validate once upgraded to v5.3+ | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md deleted file mode 100644 index 9a8c5cf9889b2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) - -## SavedObjectsUtils class - - -Signature: - -```typescript -export declare class SavedObjectsUtils -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [createEmptyFindResponse](./kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md) | static | <T, A>({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse<T, A> | Creates an empty response for a find operation. This is only intended to be used by saved objects client wrappers. | -| [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md) | static | (namespace?: string \| undefined) => string | Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the undefined namespace ID (which has a namespace string of 'default'). | -| [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md) | static | (namespace: string) => string \| undefined | Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the 'default' namespace string (which has a namespace ID of undefined). | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [generateId()](./kibana-plugin-core-server.savedobjectsutils.generateid.md) | static | Generates a random ID for a saved objects. | -| [getConvertedObjectId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md) | static | Uses a single-namespace object's "legacy ID" to determine what its new ID will be after it is converted to a multi-namespace type. | -| [isRandomId(id)](./kibana-plugin-core-server.savedobjectsutils.israndomid.md) | static | Validates that a saved object ID has been randomly generated. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md deleted file mode 100644 index 591505892e64f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md) - -## SavedObjectsUtils.namespaceIdToString property - -Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the `undefined` namespace ID (which has a namespace string of `'default'`). - -Signature: - -```typescript -static namespaceIdToString: (namespace?: string | undefined) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md deleted file mode 100644 index e052fe493b5ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md) - -## SavedObjectsUtils.namespaceStringToId property - -Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the `'default'` namespace string (which has a namespace ID of `undefined`). - -Signature: - -```typescript -static namespaceStringToId: (namespace: string) => string | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md deleted file mode 100644 index 3716db5c3d9ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) - -## SavedObjectsValidationMap interface - -A map of [validation specs](./kibana-plugin-core-server.savedobjectsvalidationspec.md) to be used for a given type. The map's keys must be valid semver versions. - -Any time you change the schema of a [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md), you should add a new entry to this map for the Kibana version the change was introduced in. - -Signature: - -```typescript -export interface SavedObjectsValidationMap -``` - -## Example - - -```typescript -const validationMap: SavedObjectsValidationMap = { - '1.0.0': schema.object({ - foo: schema.string(), - }), - '2.0.0': schema.object({ - foo: schema.string({ - minLength: 2, - validate(value) { - if (!/^[a-z]+$/.test(value)) { - return 'must be lowercase letters only'; - } - } - }), - }), -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md deleted file mode 100644 index 55938fb4b4b6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsValidationSpec](./kibana-plugin-core-server.savedobjectsvalidationspec.md) - -## SavedObjectsValidationSpec type - -Allows for validating properties using @kbn/config-schema validations. - -Signature: - -```typescript -export declare type SavedObjectsValidationSpec = ObjectType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md deleted file mode 100644 index bd1c43529895c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) - -## SavedObjectTypeExcludeFromUpgradeFilterHook type - -If defined, allows a type to run a search query and return a query filter that may match any documents which may be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which are no longer needed and may slow the migration process. - -If this hook fails, the migration will proceed without these documents having been filtered out, so this should not be used as a guarantee that these documents have been deleted. - -Experimental and subject to change - -Signature: - -```typescript -export declare type SavedObjectTypeExcludeFromUpgradeFilterHook = (toolkit: { - readonlyEsClient: Pick; -}) => estypes.QueryDslQueryContainer | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md deleted file mode 100644 index 7e4733f892955..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getAllTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md) - -## SavedObjectTypeRegistry.getAllTypes() method - -Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered, including the hidden ones. - -To only get the visible types (which is the most common use case), use `getVisibleTypes` instead. - -Signature: - -```typescript -getAllTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md deleted file mode 100644 index a20360128406a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getImportableAndExportableTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md) - -## SavedObjectTypeRegistry.getImportableAndExportableTypes() method - -Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered that are importable/exportable. - -Signature: - -```typescript -getImportableAndExportableTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md deleted file mode 100644 index 9da28c7f01278..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getIndex](./kibana-plugin-core-server.savedobjecttyperegistry.getindex.md) - -## SavedObjectTypeRegistry.getIndex() method - -Returns the `indexPattern` property for given type, or `undefined` if the type is not registered. - -Signature: - -```typescript -getIndex(type: string): string | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -string \| undefined - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md deleted file mode 100644 index d6fc255958c8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getType](./kibana-plugin-core-server.savedobjecttyperegistry.gettype.md) - -## SavedObjectTypeRegistry.getType() method - -Return the [type](./kibana-plugin-core-server.savedobjectstype.md) definition for given type name. - -Signature: - -```typescript -getType(type: string): SavedObjectsType | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -SavedObjectsType<any> \| undefined - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md deleted file mode 100644 index 9588e77e646fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getVisibleTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md) - -## SavedObjectTypeRegistry.getVisibleTypes() method - -Returns all visible [types](./kibana-plugin-core-server.savedobjectstype.md). - -A visible type is a type that doesn't explicitly define `hidden=true` during registration. - -Signature: - -```typescript -getVisibleTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md deleted file mode 100644 index 2d29e753218d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isHidden](./kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md) - -## SavedObjectTypeRegistry.isHidden() method - -Returns the `hidden` property for given type, or `false` if the type is not registered. - -Signature: - -```typescript -isHidden(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md deleted file mode 100644 index 8487af6a58911..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isImportableAndExportable](./kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md) - -## SavedObjectTypeRegistry.isImportableAndExportable() method - -Returns the `management.importableAndExportable` property for given type, or `false` if the type is not registered or does not define a management section. - -Signature: - -```typescript -isImportableAndExportable(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md deleted file mode 100644 index d4ec6de2392dd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isMultiNamespace](./kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md) - -## SavedObjectTypeRegistry.isMultiNamespace() method - -Returns whether the type is multi-namespace (shareable \*or\* isolated); resolves to `false` if the type is not registered - -Signature: - -```typescript -isMultiNamespace(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md deleted file mode 100644 index d6eca4981f7ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isNamespaceAgnostic](./kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md) - -## SavedObjectTypeRegistry.isNamespaceAgnostic() method - -Returns whether the type is namespace-agnostic (global); resolves to `false` if the type is not registered - -Signature: - -```typescript -isNamespaceAgnostic(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md deleted file mode 100644 index 0b67992e53080..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isShareable](./kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md) - -## SavedObjectTypeRegistry.isShareable() method - -Returns whether the type is multi-namespace (shareable); resolves to `false` if the type is not registered - -Signature: - -```typescript -isShareable(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md deleted file mode 100644 index d1db00d0c8162..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isSingleNamespace](./kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md) - -## SavedObjectTypeRegistry.isSingleNamespace() method - -Returns whether the type is single-namespace (isolated); resolves to `true` if the type is not registered - -Signature: - -```typescript -isSingleNamespace(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md deleted file mode 100644 index 0f2de8c8ef9b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) - -## SavedObjectTypeRegistry class - -Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md). - -Signature: - -```typescript -export declare class SavedObjectTypeRegistry -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [getAllTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md) | | Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered, including the hidden ones.To only get the visible types (which is the most common use case), use getVisibleTypes instead. | -| [getImportableAndExportableTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md) | | Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered that are importable/exportable. | -| [getIndex(type)](./kibana-plugin-core-server.savedobjecttyperegistry.getindex.md) | | Returns the indexPattern property for given type, or undefined if the type is not registered. | -| [getType(type)](./kibana-plugin-core-server.savedobjecttyperegistry.gettype.md) | | Return the [type](./kibana-plugin-core-server.savedobjectstype.md) definition for given type name. | -| [getVisibleTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md) | | Returns all visible [types](./kibana-plugin-core-server.savedobjectstype.md).A visible type is a type that doesn't explicitly define hidden=true during registration. | -| [isHidden(type)](./kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md) | | Returns the hidden property for given type, or false if the type is not registered. | -| [isImportableAndExportable(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md) | | Returns the management.importableAndExportable property for given type, or false if the type is not registered or does not define a management section. | -| [isMultiNamespace(type)](./kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md) | | Returns whether the type is multi-namespace (shareable \*or\* isolated); resolves to false if the type is not registered | -| [isNamespaceAgnostic(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md) | | Returns whether the type is namespace-agnostic (global); resolves to false if the type is not registered | -| [isShareable(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md) | | Returns whether the type is multi-namespace (shareable); resolves to false if the type is not registered | -| [isSingleNamespace(type)](./kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md) | | Returns whether the type is single-namespace (isolated); resolves to true if the type is not registered | -| [registerType(type)](./kibana-plugin-core-server.savedobjecttyperegistry.registertype.md) | | Register a [type](./kibana-plugin-core-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md deleted file mode 100644 index c0442e2aaa4ce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [registerType](./kibana-plugin-core-server.savedobjecttyperegistry.registertype.md) - -## SavedObjectTypeRegistry.registerType() method - -Register a [type](./kibana-plugin-core-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. - -Signature: - -```typescript -registerType(type: SavedObjectsType): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | SavedObjectsType | | - -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md deleted file mode 100644 index 8e2395ee6310d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectUnsanitizedDoc](./kibana-plugin-core-server.savedobjectunsanitizeddoc.md) - -## SavedObjectUnsanitizedDoc type - -Describes Saved Object documents from Kibana < 7.0.0 which don't have a `references` root property defined. This type should only be used in migrations. - -Signature: - -```typescript -export declare type SavedObjectUnsanitizedDoc = SavedObjectDoc & Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md b/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md deleted file mode 100644 index f8f05823ae81f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ScopeableRequest](./kibana-plugin-core-server.scopeablerequest.md) - -## ScopeableRequest type - -A user credentials container. It accommodates the necessary auth credentials to impersonate the current user. - -See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md). - -Signature: - -```typescript -export declare type ScopeableRequest = KibanaRequest | FakeRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md deleted file mode 100644 index a9dd0e76475fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [\_scroll\_id](./kibana-plugin-core-server.searchresponse._scroll_id.md) - -## SearchResponse.\_scroll\_id property - -Signature: - -```typescript -_scroll_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md deleted file mode 100644 index e090ad20e8bc8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [\_shards](./kibana-plugin-core-server.searchresponse._shards.md) - -## SearchResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md deleted file mode 100644 index 686e6f2aa05e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [aggregations](./kibana-plugin-core-server.searchresponse.aggregations.md) - -## SearchResponse.aggregations property - -Signature: - -```typescript -aggregations?: any; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md deleted file mode 100644 index 599c4e3ad6319..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [hits](./kibana-plugin-core-server.searchresponse.hits.md) - -## SearchResponse.hits property - -Signature: - -```typescript -hits: { - total: number; - max_score: number; - hits: Array<{ - _index: string; - _type: string; - _id: string; - _score: number; - _source: T; - _version?: number; - _explanation?: Explanation; - fields?: any; - highlight?: any; - inner_hits?: any; - matched_queries?: string[]; - sort?: unknown[]; - }>; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.md deleted file mode 100644 index 7deca96e4054c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) - -## SearchResponse interface - - -Signature: - -```typescript -export interface SearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_scroll\_id?](./kibana-plugin-core-server.searchresponse._scroll_id.md) | string | (Optional) | -| [\_shards](./kibana-plugin-core-server.searchresponse._shards.md) | ShardsResponse | | -| [aggregations?](./kibana-plugin-core-server.searchresponse.aggregations.md) | any | (Optional) | -| [hits](./kibana-plugin-core-server.searchresponse.hits.md) | { total: number; max\_score: number; hits: Array<{ \_index: string; \_type: string; \_id: string; \_score: number; \_source: T; \_version?: number; \_explanation?: Explanation; fields?: any; highlight?: any; inner\_hits?: any; matched\_queries?: string\[\]; sort?: unknown\[\]; }>; } | | -| [pit\_id?](./kibana-plugin-core-server.searchresponse.pit_id.md) | string | (Optional) | -| [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md) | boolean | | -| [took](./kibana-plugin-core-server.searchresponse.took.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md deleted file mode 100644 index f214bc0538045..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [pit\_id](./kibana-plugin-core-server.searchresponse.pit_id.md) - -## SearchResponse.pit\_id property - -Signature: - -```typescript -pit_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md deleted file mode 100644 index a3488117cd874..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md) - -## SearchResponse.timed\_out property - -Signature: - -```typescript -timed_out: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md deleted file mode 100644 index 8c9c0b0f7c420..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [took](./kibana-plugin-core-server.searchresponse.took.md) - -## SearchResponse.took property - -Signature: - -```typescript -took: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md deleted file mode 100644 index fa369aa0bdfbb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [detail](./kibana-plugin-core-server.servicestatus.detail.md) - -## ServiceStatus.detail property - -A more detailed description of the service status. - -Signature: - -```typescript -detail?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md deleted file mode 100644 index 5ef8c1251a602..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [documentationUrl](./kibana-plugin-core-server.servicestatus.documentationurl.md) - -## ServiceStatus.documentationUrl property - -A URL to open in a new tab about how to resolve or troubleshoot the problem. - -Signature: - -```typescript -documentationUrl?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md deleted file mode 100644 index 551c10c9bff82..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [level](./kibana-plugin-core-server.servicestatus.level.md) - -## ServiceStatus.level property - -The current availability level of the service. - -Signature: - -```typescript -level: ServiceStatusLevel; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.md deleted file mode 100644 index 5c04cb33a7529..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) - -## ServiceStatus interface - -The current status of a service at a point in time. - -Signature: - -```typescript -export interface ServiceStatus | unknown = unknown> -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [detail?](./kibana-plugin-core-server.servicestatus.detail.md) | string | (Optional) A more detailed description of the service status. | -| [documentationUrl?](./kibana-plugin-core-server.servicestatus.documentationurl.md) | string | (Optional) A URL to open in a new tab about how to resolve or troubleshoot the problem. | -| [level](./kibana-plugin-core-server.servicestatus.level.md) | ServiceStatusLevel | The current availability level of the service. | -| [meta?](./kibana-plugin-core-server.servicestatus.meta.md) | Meta | (Optional) Any JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained, machine-readable information about the service status. May include status information for underlying features. | -| [summary](./kibana-plugin-core-server.servicestatus.summary.md) | string | A high-level summary of the service status. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md deleted file mode 100644 index a48994daa5a4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [meta](./kibana-plugin-core-server.servicestatus.meta.md) - -## ServiceStatus.meta property - -Any JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained, machine-readable information about the service status. May include status information for underlying features. - -Signature: - -```typescript -meta?: Meta; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md deleted file mode 100644 index db90afd6f74a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [summary](./kibana-plugin-core-server.servicestatus.summary.md) - -## ServiceStatus.summary property - -A high-level summary of the service status. - -Signature: - -```typescript -summary: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md b/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md deleted file mode 100644 index 5f995ff5e13e3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatusLevel](./kibana-plugin-core-server.servicestatuslevel.md) - -## ServiceStatusLevel type - -A convenience type that represents the union of each value in [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md). - -Signature: - -```typescript -export declare type ServiceStatusLevel = typeof ServiceStatusLevels[keyof typeof ServiceStatusLevels]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md b/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md deleted file mode 100644 index e57dc192cd572..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md) - -## ServiceStatusLevels variable - -The current "level" of availability of a service. - -Signature: - -```typescript -ServiceStatusLevels: Readonly<{ - available: Readonly<{ - toString: () => "available"; - valueOf: () => 0; - toJSON: () => "available"; - }>; - degraded: Readonly<{ - toString: () => "degraded"; - valueOf: () => 1; - toJSON: () => "degraded"; - }>; - unavailable: Readonly<{ - toString: () => "unavailable"; - valueOf: () => 2; - toJSON: () => "unavailable"; - }>; - critical: Readonly<{ - toString: () => "critical"; - valueOf: () => 3; - toJSON: () => "critical"; - }>; -}> -``` - -## Remarks - -The values implement `valueOf` to allow for easy comparisons between status levels with <, >, etc. Higher values represent higher severities. Note that the default `Array.prototype.sort` implementation does not correctly sort these values. - -A snapshot serializer is available in `src/core/server/test_utils` to ease testing of these values with Jest. - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md deleted file mode 100644 index c9132b9692318..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) > [isValid](./kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md) - -## SessionCookieValidationResult.isValid property - -Whether the cookie is valid or not. - -Signature: - -```typescript -isValid: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md deleted file mode 100644 index 6c1a5e7af78a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) - -## SessionCookieValidationResult interface - -Return type from a function to validate cookie contents. - -Signature: - -```typescript -export interface SessionCookieValidationResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isValid](./kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md) | boolean | Whether the cookie is valid or not. | -| [path?](./kibana-plugin-core-server.sessioncookievalidationresult.path.md) | string | (Optional) The "Path" attribute of the cookie; if the cookie is invalid, this is used to clear it. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md deleted file mode 100644 index 59b6cb7ca6e6b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) > [path](./kibana-plugin-core-server.sessioncookievalidationresult.path.md) - -## SessionCookieValidationResult.path property - -The "Path" attribute of the cookie; if the cookie is invalid, this is used to clear it. - -Signature: - -```typescript -path?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md deleted file mode 100644 index ac34c9b17be8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [clear](./kibana-plugin-core-server.sessionstorage.clear.md) - -## SessionStorage.clear() method - -Clears current session. - -Signature: - -```typescript -clear(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md deleted file mode 100644 index 9e867b9e0fcc8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [get](./kibana-plugin-core-server.sessionstorage.get.md) - -## SessionStorage.get() method - -Retrieves session value from the session storage. - -Signature: - -```typescript -get(): Promise; -``` -Returns: - -Promise<T \| null> - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md deleted file mode 100644 index e6ddef20c22a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) - -## SessionStorage interface - -Provides an interface to store and retrieve data across requests. - -Signature: - -```typescript -export interface SessionStorage -``` - -## Methods - -| Method | Description | -| --- | --- | -| [clear()](./kibana-plugin-core-server.sessionstorage.clear.md) | Clears current session. | -| [get()](./kibana-plugin-core-server.sessionstorage.get.md) | Retrieves session value from the session storage. | -| [set(sessionValue)](./kibana-plugin-core-server.sessionstorage.set.md) | Puts current session value into the session storage. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md deleted file mode 100644 index a17aadf8fb984..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [set](./kibana-plugin-core-server.sessionstorage.set.md) - -## SessionStorage.set() method - -Puts current session value into the session storage. - -Signature: - -```typescript -set(sessionValue: T): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sessionValue | T | value to put | - -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md deleted file mode 100644 index 377ce19b31601..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [encryptionKey](./kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md) - -## SessionStorageCookieOptions.encryptionKey property - -A key used to encrypt a cookie's value. Should be at least 32 characters long. - -Signature: - -```typescript -encryptionKey: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md deleted file mode 100644 index fc401fa99b83c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [isSecure](./kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md) - -## SessionStorageCookieOptions.isSecure property - -Flag indicating whether the cookie should be sent only via a secure connection. - -Signature: - -```typescript -isSecure: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md deleted file mode 100644 index 425daf32f5cb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) - -## SessionStorageCookieOptions interface - -Configuration used to create HTTP session storage based on top of cookie mechanism. - -Signature: - -```typescript -export interface SessionStorageCookieOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [encryptionKey](./kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md) | string | A key used to encrypt a cookie's value. Should be at least 32 characters long. | -| [isSecure](./kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md) | boolean | Flag indicating whether the cookie should be sent only via a secure connection. | -| [name](./kibana-plugin-core-server.sessionstoragecookieoptions.name.md) | string | Name of the session cookie. | -| [sameSite?](./kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md) | 'Strict' \| 'Lax' \| 'None' | (Optional) Defines SameSite attribute of the Set-Cookie Header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite | -| [validate](./kibana-plugin-core-server.sessionstoragecookieoptions.validate.md) | (sessionValue: T \| T\[\]) => SessionCookieValidationResult | Function called to validate a cookie's decrypted value. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md deleted file mode 100644 index 47c1926415221..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [name](./kibana-plugin-core-server.sessionstoragecookieoptions.name.md) - -## SessionStorageCookieOptions.name property - -Name of the session cookie. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md deleted file mode 100644 index a2bf79a52d521..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [sameSite](./kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md) - -## SessionStorageCookieOptions.sameSite property - -Defines SameSite attribute of the Set-Cookie Header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite - -Signature: - -```typescript -sameSite?: 'Strict' | 'Lax' | 'None'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md deleted file mode 100644 index 2626c94f6afb1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [validate](./kibana-plugin-core-server.sessionstoragecookieoptions.validate.md) - -## SessionStorageCookieOptions.validate property - -Function called to validate a cookie's decrypted value. - -Signature: - -```typescript -validate: (sessionValue: T | T[]) => SessionCookieValidationResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md deleted file mode 100644 index be3c997a0aa71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) > [asScoped](./kibana-plugin-core-server.sessionstoragefactory.asscoped.md) - -## SessionStorageFactory.asScoped property - -Signature: - -```typescript -asScoped: (request: KibanaRequest) => SessionStorage; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md deleted file mode 100644 index 7bdea28beeda1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) - -## SessionStorageFactory interface - -SessionStorage factory to bind one to an incoming request - -Signature: - -```typescript -export interface SessionStorageFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asScoped](./kibana-plugin-core-server.sessionstoragefactory.asscoped.md) | (request: KibanaRequest) => SessionStorage<T> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md deleted file mode 100644 index a47fc1263be41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [failed](./kibana-plugin-core-server.shardsinfo.failed.md) - -## ShardsInfo.failed property - -Signature: - -```typescript -failed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md deleted file mode 100644 index 6c006c020d3fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) - -## ShardsInfo interface - - -Signature: - -```typescript -export interface ShardsInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [failed](./kibana-plugin-core-server.shardsinfo.failed.md) | number | | -| [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md) | number | | -| [successful](./kibana-plugin-core-server.shardsinfo.successful.md) | number | | -| [total](./kibana-plugin-core-server.shardsinfo.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md deleted file mode 100644 index 0c87831edd6ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md) - -## ShardsInfo.skipped property - -Signature: - -```typescript -skipped: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md deleted file mode 100644 index c927adb39932a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [successful](./kibana-plugin-core-server.shardsinfo.successful.md) - -## ShardsInfo.successful property - -Signature: - -```typescript -successful: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md deleted file mode 100644 index 820c8a70fd222..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [total](./kibana-plugin-core-server.shardsinfo.total.md) - -## ShardsInfo.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md deleted file mode 100644 index 7f7a173af2e58..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [failed](./kibana-plugin-core-server.shardsresponse.failed.md) - -## ShardsResponse.failed property - -Signature: - -```typescript -failed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md deleted file mode 100644 index 65e113f05212f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) - -## ShardsResponse interface - - -Signature: - -```typescript -export interface ShardsResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [failed](./kibana-plugin-core-server.shardsresponse.failed.md) | number | | -| [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md) | number | | -| [successful](./kibana-plugin-core-server.shardsresponse.successful.md) | number | | -| [total](./kibana-plugin-core-server.shardsresponse.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md deleted file mode 100644 index b01c3501fe022..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md) - -## ShardsResponse.skipped property - -Signature: - -```typescript -skipped: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md deleted file mode 100644 index 23c6ff0519ed7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [successful](./kibana-plugin-core-server.shardsresponse.successful.md) - -## ShardsResponse.successful property - -Signature: - -```typescript -successful: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md deleted file mode 100644 index e669f6216a10f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [total](./kibana-plugin-core-server.shardsresponse.total.md) - -## ShardsResponse.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md b/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md deleted file mode 100644 index 477cd5a651a56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SharedGlobalConfig](./kibana-plugin-core-server.sharedglobalconfig.md) - -## SharedGlobalConfig type - - -Signature: - -```typescript -export declare type SharedGlobalConfig = RecursiveReadonly<{ - elasticsearch: Pick; - path: Pick; - savedObjects: Pick; -}>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md b/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md deleted file mode 100644 index 7f90060d3ffa8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) - -## StartServicesAccessor type - -Allows plugins to get access to APIs available in start inside async handlers. Promise will not resolve until Core and plugin dependencies have completed `start`. This should only be used inside handlers registered during `setup` that will only be executed after `start` lifecycle. - -Signature: - -```typescript -export declare type StartServicesAccessor = () => Promise<[CoreStart, TPluginsStart, TStart]>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md deleted file mode 100644 index 6662e68b44d36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [core$](./kibana-plugin-core-server.statusservicesetup.core_.md) - -## StatusServiceSetup.core$ property - -Current status for all Core services. - -Signature: - -```typescript -core$: Observable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md deleted file mode 100644 index 7475f0e3a4c1c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md) - -## StatusServiceSetup.dependencies$ property - -Current status for all plugins this plugin depends on. Each key of the `Record` is a plugin id. - -Signature: - -```typescript -dependencies$: Observable>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md deleted file mode 100644 index 96784359457fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) - -## StatusServiceSetup.derivedStatus$ property - -The status of this plugin as derived from its dependencies. - -Signature: - -```typescript -derivedStatus$: Observable; -``` - -## Remarks - -By default, plugins inherit this derived status from their dependencies. Calling overrides this default status. - -This may emit multiple times for a single status change event as propagates through the dependency tree - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md deleted file mode 100644 index c417aaa2cef48..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [isStatusPageAnonymous](./kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md) - -## StatusServiceSetup.isStatusPageAnonymous property - -Whether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is present. - -Signature: - -```typescript -isStatusPageAnonymous: () => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md deleted file mode 100644 index 5409772c369c2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md +++ /dev/null @@ -1,83 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) - -## StatusServiceSetup interface - -API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status. - -Signature: - -```typescript -export interface StatusServiceSetup -``` - -## Remarks - -By default, a plugin inherits it's current status from the most severe status level of any Core services and any plugins that it depends on. This default status is available on the API. - -Plugins may customize their status calculation by calling the API with an Observable. Within this Observable, a plugin may choose to only depend on the status of some of its dependencies, to ignore severe status levels of particular Core services they are not concerned with, or to make its status dependent on other external services. - -## Example 1 - -Customize a plugin's status to only depend on the status of SavedObjects: - -```ts -core.status.set( - core.status.core$.pipe( -. map((coreStatus) => { - return coreStatus.savedObjects; - }) ; - ); -); -``` - -## Example 2 - -Customize a plugin's status to include an external service: - -```ts -const externalStatus$ = interval(1000).pipe( - switchMap(async () => { - const resp = await fetch(`https://myexternaldep.com/_healthz`); - const body = await resp.json(); - if (body.ok) { - return of({ level: ServiceStatusLevels.available, summary: 'External Service is up'}); - } else { - return of({ level: ServiceStatusLevels.available, summary: 'External Service is unavailable'}); - } - }), - catchError((error) => { - of({ level: ServiceStatusLevels.unavailable, summary: `External Service is down`, meta: { error }}) - }) -); - -core.status.set( - combineLatest([core.status.derivedStatus$, externalStatus$]).pipe( - map(([derivedStatus, externalStatus]) => { - if (externalStatus.level > derivedStatus) { - return externalStatus; - } else { - return derivedStatus; - } - }) - ) -); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [core$](./kibana-plugin-core-server.statusservicesetup.core_.md) | Observable<CoreStatus> | Current status for all Core services. | -| [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md) | Observable<Record<string, ServiceStatus>> | Current status for all plugins this plugin depends on. Each key of the Record is a plugin id. | -| [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) | Observable<ServiceStatus> | The status of this plugin as derived from its dependencies. | -| [isStatusPageAnonymous](./kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md) | () => boolean | Whether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is present. | -| [overall$](./kibana-plugin-core-server.statusservicesetup.overall_.md) | Observable<ServiceStatus> | Overall system status for all of Kibana. | - -## Methods - -| Method | Description | -| --- | --- | -| [set(status$)](./kibana-plugin-core-server.statusservicesetup.set.md) | Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md deleted file mode 100644 index bb7c31311d520..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [overall$](./kibana-plugin-core-server.statusservicesetup.overall_.md) - -## StatusServiceSetup.overall$ property - -Overall system status for all of Kibana. - -Signature: - -```typescript -overall$: Observable; -``` - -## Remarks - -The level of the overall status will reflect the most severe status of any core service or plugin. - -Exposed only for reporting purposes to outside systems and should not be used by plugins. Instead, plugins should only depend on the statuses of [Core](./kibana-plugin-core-server.statusservicesetup.core_.md) or their dependencies. - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md deleted file mode 100644 index b60319e19529a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [set](./kibana-plugin-core-server.statusservicesetup.set.md) - -## StatusServiceSetup.set() method - -Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status. - -Signature: - -```typescript -set(status$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| status$ | Observable<ServiceStatus> | | - -Returns: - -void - -## Remarks - -The first emission from this Observable should occur within 30s, else this plugin's status will fallback to `unavailable` until the first emission. - -See the [StatusServiceSetup.derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) API for leveraging the default status calculation that is provided by Core. - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md deleted file mode 100644 index 224df5f073eb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [category](./kibana-plugin-core-server.uisettingsparams.category.md) - -## UiSettingsParams.category property - -used to group the configured setting in the UI - -Signature: - -```typescript -category?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md deleted file mode 100644 index 0be426d609606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [deprecation](./kibana-plugin-core-server.uisettingsparams.deprecation.md) - -## UiSettingsParams.deprecation property - -optional deprecation information. Used to generate a deprecation warning. - -Signature: - -```typescript -deprecation?: DeprecationSettings; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md deleted file mode 100644 index 5ba8244e6cfb4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [description](./kibana-plugin-core-server.uisettingsparams.description.md) - -## UiSettingsParams.description property - -description provided to a user in UI - -Signature: - -```typescript -description?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md deleted file mode 100644 index 531a0e75c97b0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) - -## UiSettingsParams interface - -UiSettings parameters defined by the plugins. - -Signature: - -```typescript -export interface UiSettingsParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./kibana-plugin-core-server.uisettingsparams.category.md) | string\[\] | (Optional) used to group the configured setting in the UI | -| [deprecation?](./kibana-plugin-core-server.uisettingsparams.deprecation.md) | DeprecationSettings | (Optional) optional deprecation information. Used to generate a deprecation warning. | -| [description?](./kibana-plugin-core-server.uisettingsparams.description.md) | string | (Optional) description provided to a user in UI | -| [metric?](./kibana-plugin-core-server.uisettingsparams.metric.md) | { type: UiCounterMetricType; name: string; } | (Optional) Metric to track once this property changes | -| [name?](./kibana-plugin-core-server.uisettingsparams.name.md) | string | (Optional) title in the UI | -| [optionLabels?](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) | Record<string, string> | (Optional) text labels for 'select' type UI element | -| [options?](./kibana-plugin-core-server.uisettingsparams.options.md) | string\[\] | (Optional) array of permitted values for this setting | -| [order?](./kibana-plugin-core-server.uisettingsparams.order.md) | number | (Optional) index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. settings without order defined will be displayed last and ordered by name | -| [readonly?](./kibana-plugin-core-server.uisettingsparams.readonly.md) | boolean | (Optional) a flag indicating that value cannot be changed | -| [requiresPageReload?](./kibana-plugin-core-server.uisettingsparams.requirespagereload.md) | boolean | (Optional) a flag indicating whether new value applying requires page reloading | -| [schema](./kibana-plugin-core-server.uisettingsparams.schema.md) | Type<T> | | -| [sensitive?](./kibana-plugin-core-server.uisettingsparams.sensitive.md) | boolean | (Optional) a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. | -| [type?](./kibana-plugin-core-server.uisettingsparams.type.md) | UiSettingsType | (Optional) defines a type of UI element [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) | -| [value?](./kibana-plugin-core-server.uisettingsparams.value.md) | T | (Optional) default value to fall back to if a user doesn't provide any | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md deleted file mode 100644 index 8491de9a8f5dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) - -## UiSettingsParams.metric property - -> Warning: This API is now obsolete. -> -> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place -> - -Metric to track once this property changes - -Signature: - -```typescript -metric?: { - type: UiCounterMetricType; - name: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md deleted file mode 100644 index 248498c232c9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [name](./kibana-plugin-core-server.uisettingsparams.name.md) - -## UiSettingsParams.name property - -title in the UI - -Signature: - -```typescript -name?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md deleted file mode 100644 index 97a66e71fb846..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [optionLabels](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) - -## UiSettingsParams.optionLabels property - -text labels for 'select' type UI element - -Signature: - -```typescript -optionLabels?: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md deleted file mode 100644 index 94eff9f0a0146..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [options](./kibana-plugin-core-server.uisettingsparams.options.md) - -## UiSettingsParams.options property - -array of permitted values for this setting - -Signature: - -```typescript -options?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md deleted file mode 100644 index 140bdad5d786b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [order](./kibana-plugin-core-server.uisettingsparams.order.md) - -## UiSettingsParams.order property - -index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. - - settings without order defined will be displayed last and ordered by name - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md deleted file mode 100644 index b9342eff345c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [readonly](./kibana-plugin-core-server.uisettingsparams.readonly.md) - -## UiSettingsParams.readonly property - -a flag indicating that value cannot be changed - -Signature: - -```typescript -readonly?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md deleted file mode 100644 index 46bfa291857d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [requiresPageReload](./kibana-plugin-core-server.uisettingsparams.requirespagereload.md) - -## UiSettingsParams.requiresPageReload property - -a flag indicating whether new value applying requires page reloading - -Signature: - -```typescript -requiresPageReload?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md deleted file mode 100644 index f181fbd309b7f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [schema](./kibana-plugin-core-server.uisettingsparams.schema.md) - -## UiSettingsParams.schema property - -Signature: - -```typescript -schema: Type; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md deleted file mode 100644 index f2c7de19dde1a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [sensitive](./kibana-plugin-core-server.uisettingsparams.sensitive.md) - -## UiSettingsParams.sensitive property - -a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. - -Signature: - -```typescript -sensitive?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md deleted file mode 100644 index 9d663f05713c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [type](./kibana-plugin-core-server.uisettingsparams.type.md) - -## UiSettingsParams.type property - -defines a type of UI element [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) - -Signature: - -```typescript -type?: UiSettingsType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md deleted file mode 100644 index 78c8f0c8fcf8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [value](./kibana-plugin-core-server.uisettingsparams.value.md) - -## UiSettingsParams.value property - -default value to fall back to if a user doesn't provide any - -Signature: - -```typescript -value?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md deleted file mode 100644 index 97b711bca303a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) - -## UiSettingsServiceSetup interface - - -Signature: - -```typescript -export interface UiSettingsServiceSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [register(settings)](./kibana-plugin-core-server.uisettingsservicesetup.register.md) | Sets settings with default values for the uiSettings. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md deleted file mode 100644 index 97b06ddb00e70..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) > [register](./kibana-plugin-core-server.uisettingsservicesetup.register.md) - -## UiSettingsServiceSetup.register() method - -Sets settings with default values for the uiSettings. - -Signature: - -```typescript -register(settings: Record): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| settings | Record<string, UiSettingsParams> | | - -Returns: - -void - -## Example - - -```ts -setup(core: CoreSetup){ - core.uiSettings.register([{ - foo: { - name: i18n.translate('my foo settings'), - value: true, - description: 'add some awesomeness', - }, - }]); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md deleted file mode 100644 index 1d76bc26a4150..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) > [asScopedToClient](./kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md) - -## UiSettingsServiceStart.asScopedToClient() method - -Creates a [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) with provided \*scoped\* saved objects client. - -This should only be used in the specific case where the client needs to be accessed from outside of the scope of a [RequestHandler](./kibana-plugin-core-server.requesthandler.md). - -Signature: - -```typescript -asScopedToClient(savedObjectsClient: SavedObjectsClientContract): IUiSettingsClient; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| savedObjectsClient | SavedObjectsClientContract | | - -Returns: - -IUiSettingsClient - -## Example - - -```ts -start(core: CoreStart) { - const soClient = core.savedObjects.getScopedClient(arbitraryRequest); - const uiSettingsClient = core.uiSettings.asScopedToClient(soClient); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md deleted file mode 100644 index 014f7d533b2ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) - -## UiSettingsServiceStart interface - - -Signature: - -```typescript -export interface UiSettingsServiceStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [asScopedToClient(savedObjectsClient)](./kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md) | Creates a [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) with provided \*scoped\* saved objects client.This should only be used in the specific case where the client needs to be accessed from outside of the scope of a [RequestHandler](./kibana-plugin-core-server.requesthandler.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md b/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md deleted file mode 100644 index 7edee442baa24..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) - -## UiSettingsType type - -UI element type to represent the settings. - -Signature: - -```typescript -export declare type UiSettingsType = 'undefined' | 'json' | 'markdown' | 'number' | 'select' | 'boolean' | 'string' | 'array' | 'image' | 'color'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md deleted file mode 100644 index a79d62ab7f3c7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedError](./kibana-plugin-core-server.unauthorizederror.md) - -## UnauthorizedError type - - -Signature: - -```typescript -export declare type UnauthorizedError = errors.ResponseError & { - statusCode: 401; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md deleted file mode 100644 index 10c6253619217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) - -## UnauthorizedErrorHandler type - -A handler used to handle unauthorized error returned by elasticsearch - -Signature: - -```typescript -export declare type UnauthorizedErrorHandler = (options: UnauthorizedErrorHandlerOptions, toolkit: UnauthorizedErrorHandlerToolkit) => MaybePromise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md deleted file mode 100644 index 2300d53816e07..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) - -## UnauthorizedErrorHandlerNotHandledResult interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerNotHandledResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md) | 'notHandled' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md deleted file mode 100644 index 9a8fc62517bce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) > [type](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md) - -## UnauthorizedErrorHandlerNotHandledResult.type property - -Signature: - -```typescript -type: 'notHandled'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md deleted file mode 100644 index b3b355dfdc97e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) > [error](./kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md) - -## UnauthorizedErrorHandlerOptions.error property - -Signature: - -```typescript -error: UnauthorizedError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md deleted file mode 100644 index efaf5109568be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) - -## UnauthorizedErrorHandlerOptions interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md) | UnauthorizedError | | -| [request](./kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md) | KibanaRequest | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md deleted file mode 100644 index 94a0970844615..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) > [request](./kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md) - -## UnauthorizedErrorHandlerOptions.request property - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md deleted file mode 100644 index fb5d8ad7d35c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResult](./kibana-plugin-core-server.unauthorizederrorhandlerresult.md) - -## UnauthorizedErrorHandlerResult type - - -Signature: - -```typescript -export declare type UnauthorizedErrorHandlerResult = UnauthorizedErrorHandlerRetryResult | UnauthorizedErrorHandlerNotHandledResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md deleted file mode 100644 index f6a8cb3d5b613..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) > [authHeaders](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md) - -## UnauthorizedErrorHandlerResultRetryParams.authHeaders property - -Signature: - -```typescript -authHeaders: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md deleted file mode 100644 index d9c8e4c0733a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) - -## UnauthorizedErrorHandlerResultRetryParams interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerResultRetryParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authHeaders](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md) | AuthHeaders | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md deleted file mode 100644 index 09d7f08229be3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) - -## UnauthorizedErrorHandlerRetryResult interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerRetryResult extends UnauthorizedErrorHandlerResultRetryParams -``` -Extends: UnauthorizedErrorHandlerResultRetryParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md) | 'retry' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md deleted file mode 100644 index 64d1e9270682b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) > [type](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md) - -## UnauthorizedErrorHandlerRetryResult.type property - -Signature: - -```typescript -type: 'retry'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md deleted file mode 100644 index f28dae053b351..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) - -## UnauthorizedErrorHandlerToolkit interface - -Toolkit passed to a [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) used to generate responses from the handler - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [notHandled](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md) | () => UnauthorizedErrorHandlerNotHandledResult | The handler cannot handle the error, or was not able to authenticate. | -| [retry](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md) | (params: UnauthorizedErrorHandlerResultRetryParams) => UnauthorizedErrorHandlerRetryResult | The handler was able to authenticate. Will retry the failed request with new auth headers | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md deleted file mode 100644 index 76fc3dd48ff74..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) > [notHandled](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md) - -## UnauthorizedErrorHandlerToolkit.notHandled property - -The handler cannot handle the error, or was not able to authenticate. - -Signature: - -```typescript -notHandled: () => UnauthorizedErrorHandlerNotHandledResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md deleted file mode 100644 index 6a5e5c78414ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) > [retry](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md) - -## UnauthorizedErrorHandlerToolkit.retry property - -The handler was able to authenticate. Will retry the failed request with new auth headers - -Signature: - -```typescript -retry: (params: UnauthorizedErrorHandlerResultRetryParams) => UnauthorizedErrorHandlerRetryResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md deleted file mode 100644 index 12fc1af0d6ae9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) > [isOverridden](./kibana-plugin-core-server.userprovidedvalues.isoverridden.md) - -## UserProvidedValues.isOverridden property - -Signature: - -```typescript -isOverridden?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md deleted file mode 100644 index fe8aaf233fbf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) - -## UserProvidedValues interface - -Describes the values explicitly set by user. - -Signature: - -```typescript -export interface UserProvidedValues -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isOverridden?](./kibana-plugin-core-server.userprovidedvalues.isoverridden.md) | boolean | (Optional) | -| [userValue?](./kibana-plugin-core-server.userprovidedvalues.uservalue.md) | T | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md deleted file mode 100644 index 6840f66d6f9f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) > [userValue](./kibana-plugin-core-server.userprovidedvalues.uservalue.md) - -## UserProvidedValues.userValue property - -Signature: - -```typescript -userValue?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md b/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md deleted file mode 100644 index 97d6a42602ab5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [validBodyOutput](./kibana-plugin-core-server.validbodyoutput.md) - -## validBodyOutput variable - -The set of valid body.output - -Signature: - -```typescript -validBodyOutput: readonly ["data", "stream"] -``` diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 2aa160674b744..120617ea4de94 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -215,7 +215,7 @@ When enabled, provides access to the experimental *Labs* features for *Canvas*. [[labs-dashboard-defer-below-fold]]`labs:dashboard:deferBelowFold`:: When enabled, the panels that appear below the fold are loaded when they become visible on the dashboard. -_Below the fold_ refers to panels that are not immediately visible when you open a dashboard, but become visible as you scroll. For additional information, refer to <>. +_Below the fold_ refers to panels that are not immediately visible when you open a dashboard, but become visible as you scroll. For additional information, refer to <>. [[labs-dashboard-enable-ui]]`labs:dashboard:enable_ui`:: When enabled, provides access to the experimental *Labs* features for *Dashboard*. diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc index bf13661b9aadd..842f2e93bc58e 100644 --- a/docs/user/dashboard/aggregation-based.asciidoc +++ b/docs/user/dashboard/aggregation-based.asciidoc @@ -172,7 +172,7 @@ To create the bar chart, add a <>, then .. Click *Update*. + [role="screenshot"] -image:images/bar-chart-tutorial-1.png[Bar chart with sample logs data] +image:images/aggBased_barChartTutorial1_8.3.png[Bar chart with sample logs data] . To show the top five log traffic sources, add a sub-bucket aggregation. @@ -187,7 +187,7 @@ TIP: Aggregation-based panels support a maximum of three *Split series*. .. Click *Update*. + [role="screenshot"] -image:images/bar-chart-tutorial-2.png[Bar chart with sample logs data] +image:images/aggBased_barChartTutorial2_8.3.png[Bar chart with sample logs data] [float] [[save-the-aggregation-based-panel]] diff --git a/docs/user/dashboard/dashboard-troubleshooting.asciidoc b/docs/user/dashboard/dashboard-troubleshooting.asciidoc index d9bf80a5b1996..7fe1b7c3067b9 100644 --- a/docs/user/dashboard/dashboard-troubleshooting.asciidoc +++ b/docs/user/dashboard/dashboard-troubleshooting.asciidoc @@ -1,14 +1,5 @@ [[dashboard-troubleshooting]] -== Dashboard and visualizations troubleshooting -++++ -Troubleshooting -++++ - -Find solutions to common dashboard and visualization issues. - -[float] -[[defer-loading-panels-below-the-fold]] -=== Improve dashboard loading time +== Improve dashboard loading time To improve the dashboard loading time, enable *Defer loading panels below the fold* *Lab*, which loads dashboard panels as they become visible on the dashboard. @@ -26,44 +17,3 @@ To enable *Labs*, contact your administrator, or configure the < Aggregation based*, then select *Timelion*. - -.. In your browser, open a new tab, the open the *Timelion* app. - -.. Select the chart you want to copy, then copy the chart expression. -+ -[role="screenshot"] -image::images/timelion-copy-expression.png[Timelion app chart] - -.. Go to the *Timelion* editor, paste the chart expression in the *Timelion expression* field, then click *Update*. -+ -[role="screenshot"] -image::images/timelion-vis-paste-expression.png[Timelion advanced editor UI] - -. Save the visualization. - -.. In the toolbar, click *Save to library*. - -.. Enter the *Title* and add any applicable <>. - -.. Make sure that *Add to Dashboard after saving* is selected. - -.. Click *Save and return*. -+ -The Timelion visualization panel appears on the dashboard. -+ -[role="screenshot"] -image::user/dashboard/images/timelion-dashboard.png[Final dashboard with saved Timelion app worksheet] - diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc index b63bbdc75e9f9..e0e469c0d7d11 100644 --- a/docs/user/dashboard/dashboard.asciidoc +++ b/docs/user/dashboard/dashboard.asciidoc @@ -337,6 +337,8 @@ Apply a set of design options to the entire dashboard. * *Sync color pallettes across panels* — Applies the same color palette to all panels on the dashboard. +* *Sync tooltips across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY chart, the tooltips on all other related dashboard charts automatically appear. + [float] [[save-dashboards]] == Save dashboards diff --git a/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png b/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png new file mode 100644 index 0000000000000..3322459294d3c Binary files /dev/null and b/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png differ diff --git a/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png b/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png new file mode 100644 index 0000000000000..a30fe3fbd1b78 Binary files /dev/null and b/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png differ diff --git a/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png b/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png new file mode 100644 index 0000000000000..d1d7f0644db31 Binary files /dev/null and b/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif new file mode 100644 index 0000000000000..2015830f68fec Binary files /dev/null and b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png new file mode 100644 index 0000000000000..06ad04c8d1e30 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif b/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif new file mode 100644 index 0000000000000..9a50761f7bc24 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png b/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png new file mode 100644 index 0000000000000..e2df865c610a8 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png b/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png new file mode 100644 index 0000000000000..bd7b9e42c936f Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif b/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif new file mode 100644 index 0000000000000..3edf44454ec5f Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png b/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png new file mode 100644 index 0000000000000..6556485259d6e Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png differ diff --git a/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png b/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png new file mode 100644 index 0000000000000..01b20fe0a1a4c Binary files /dev/null and b/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png differ diff --git a/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png b/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png new file mode 100644 index 0000000000000..2a4c2abee24af Binary files /dev/null and b/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png differ diff --git a/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png b/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png new file mode 100644 index 0000000000000..857f28303b8cb Binary files /dev/null and b/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png differ diff --git a/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png b/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png new file mode 100644 index 0000000000000..5a6cfb2bf740a Binary files /dev/null and b/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png differ diff --git a/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png b/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png new file mode 100644 index 0000000000000..9c2e3626bc07f Binary files /dev/null and b/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png differ diff --git a/docs/user/dashboard/images/lens_logsDashboard_8.3.png b/docs/user/dashboard/images/lens_logsDashboard_8.3.png new file mode 100644 index 0000000000000..089fd5dcadb0c Binary files /dev/null and b/docs/user/dashboard/images/lens_logsDashboard_8.3.png differ diff --git a/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png b/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png new file mode 100644 index 0000000000000..93447edf25c91 Binary files /dev/null and b/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png differ diff --git a/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png b/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png new file mode 100644 index 0000000000000..80b1763d32633 Binary files /dev/null and b/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png differ diff --git a/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png b/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png new file mode 100644 index 0000000000000..9cf54d1cbfdc1 Binary files /dev/null and b/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png differ diff --git a/docs/user/dashboard/lens-advanced.asciidoc b/docs/user/dashboard/lens-advanced.asciidoc index d98fd6c45c49f..68516b49d2158 100644 --- a/docs/user/dashboard/lens-advanced.asciidoc +++ b/docs/user/dashboard/lens-advanced.asciidoc @@ -6,7 +6,7 @@ In this tutorial, you'll use the ecommerce sample data to analyze sales trends, When you're done, you'll have a complete overview of the sample web logs data. [role="screenshot"] -image::images/lens_timeSeriesDataTutorialDashboard_7.16.png[Final dashboard with ecommerce sample data] +image::images/lens_timeSeriesDataTutorialDashboard_8.3.png[Final dashboard with ecommerce sample data] Before you begin, you should be familiar with the <>. @@ -34,7 +34,7 @@ Open the visualization editor, then make sure the correct fields appear. . On the dashboard, click *Create visualization*. -. Make sure the *kibana_sample_data_ecommerce* {data-source} appears, then set the <> to *Last 30 days*. +. Make sure the *Kibana Sample Data eCommerce* {data-source} appears, then set the <> to *Last 30 days*. [discrete] [[custom-time-interval]] @@ -55,7 +55,7 @@ image::images/lens_clickAndDragZoom_7.16.gif[Cursor clicking and dragging across . In the layer pane, click *Count of Records*. -.. In the *Display name* field, enter `Number of orders`. +.. In the *Name* field, enter `Number of orders`. .. Click *Add advanced options > Normalize by unit*. @@ -63,7 +63,7 @@ image::images/lens_clickAndDragZoom_7.16.gif[Cursor clicking and dragging across + *Normalize unit* converts *Average sales per 12 hours* into *Average sales per 12 hours (per hour)* by dividing the number of hours. -. To hide the *Horizontal axis* label, open the *Bottom Axis* menu, then deselect *Show*. +. To hide the *Horizontal axis* label, open the *Bottom Axis* menu, then select *None* from the *Axis title* dropdown. To identify the 75th percentile of orders, add a reference line: @@ -71,13 +71,17 @@ To identify the 75th percentile of orders, add a reference line: . Click *Static value*. -. Click the *Percentile* function, then enter `75` in the *Percentile* field. +.. Click *Quick functions*, then click *Percentile*. + +.. From the *Field* dropdown, select *total_quantity*. + +.. In the *Percentile* field, enter `75`. . Configure the display options. -.. In the *Display name* field, enter `75th`. +.. In the *Name* field, enter `75th`. -.. Select *Show display name*. +.. To display the name, select *Name* from *Text decoration*. .. From the *Icon* dropdown, select *Tag*. @@ -86,7 +90,7 @@ To identify the 75th percentile of orders, add a reference line: . Click *Close*. + [role="screenshot"] -image::images/lens_barChartCustomTimeInterval_7.16.png[Orders per day] +image::images/lens_barChartCustomTimeInterval_8.3.png[Orders per day] . Click *Save and return*. @@ -110,7 +114,7 @@ Create the 95th price distribution percentile: . Click the *Percentile* function. -. In the *Display name* field, enter `95th`, then click *Close*. +. In the *Name* field, enter `95th`, then click *Close*. To copy a function, you drag it to the *Drop a field or click to add* field within the same group. To create the 90th percentile, duplicate the `95th` percentile: @@ -121,11 +125,11 @@ image::images/lens_advanced_2_2.gif[Easily duplicate the items with drag and dro . Click *95th [1]*, then enter `90` in the *Percentile* field. -. In the *Display name* field enter `90th`, then click *Close*. +. In the *Name* field enter `90th`, then click *Close*. . To create the `50th` and `10th` percentiles, repeat the duplication steps. -. Open the *Left Axis* menu, then enter `Percentiles for product prices` in the *Axis name* field. +. Open the *Left Axis* menu, select *Custom* from the *Axis title* dropdown, then enter `Percentiles for product prices` in the *Axis title* field. + [role="screenshot"] image::images/lens_lineChartMultipleDataSeries_7.16.png[Percentiles for product prices chart] @@ -148,7 +152,7 @@ To analyze multiple visualization types, create an area chart that displays the .. Click the *Average* function. -.. In the *Display name* field, enter `Average price`, then click *Close*. +.. In the *Name* field, enter `Average price`, then click *Close*. . Open the *Visualization type* dropdown, then select *Area*. @@ -160,7 +164,7 @@ Add a layer to display the customer traffic: . In the layer pane, click *Unique count of customer_id*. -.. In the *Display name* field, enter `Number of customers`. +.. In the *Name* field, enter `Number of customers`. .. In the *Series color* field, enter *#D36086*. @@ -223,7 +227,7 @@ For each order category, create a filter: . Open the *Legend* menu, then select the *Alignment* arrow that points up. + [role="screenshot"] -image::images/lens_areaPercentageNumberOfOrdersByCategory_7.16.png[Prices share by category] +image::images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png[Prices share by category] . Click *Save and return*. @@ -245,7 +249,7 @@ Configure the cumulative sum of store orders: . Click the *Cumulative sum* function. -. In the *Display name* field, enter `Cumulative weekend orders`, then click *Close*. +. In the *Name* field, enter `Cumulative weekend orders`, then click *Close*. Filter the results to display the data for only Saturday and Sunday: @@ -261,7 +265,7 @@ Filter the results to display the data for only Saturday and Sunday: + The <> displays all documents where `day_of_week` matches `Saturday` or `Sunday`. -. Open the *Legend* menu, then click *Hide*. +. Open the *Legend* menu, then click *Hide* next to *Display*. + [role="screenshot"] image::images/lens_areaChartCumulativeNumberOfSalesOnWeekend_7.16.png[Area chart with cumulative sum of orders made on the weekend] @@ -318,7 +322,7 @@ To compare time range changes as a percent, create a bar chart that compares the . Open the *Value format* dropdown, select *Percent*, then enter `0` in the *Decimals* field. -. In the *Display name* field, enter `Percent of change`, then click *Close*. +. In the *Name* field, enter `Percent of change`, then click *Close*. + [role="screenshot"] image::images/lens_percent_chage.png[Bar chart with percent change in sales between the current time and the previous week] @@ -341,17 +345,15 @@ Create a date histogram table and group the customer count metric by category, s .. In the layer pane, click *Unique count of customer_id*. -.. In the *Display name* field, enter `Customers`, then click *Close*. +.. In the *Name* field, enter `Customers`, then click *Close*. . From the *Available fields* list, drag *order_date* to the *Rows* field in the layer pane. .. In the layer pane, click the *order_date*. -.. Select *Customize time interval*. - -.. Change the *Minimum interval* to *1 days*. +.. In the *Minimum interval* field, enter *1d*. -.. In the *Display name* field, enter `Sales`, then click *Close*. +.. In the *Name* field, enter `Sales`, then click *Close*. To split the metric, add columns for each continent using the *Columns* field: @@ -376,4 +378,4 @@ Now that you have a complete overview of your ecommerce sales data, save the das . Click *Save*. [role="screenshot"] -image::images/lens_timeSeriesDataTutorialDashboard_7.16.png[Final dashboard with ecommerce sample data] +image::images/lens_timeSeriesDataTutorialDashboard_8.3.png[Final dashboard with ecommerce sample data] diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index b062dcc3349ad..8e8ffe902a565 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -40,7 +40,7 @@ If you already know the visualization type you want to use, and how you want to Choose the visualization type. -. Before you drag fields to the workspace, open the *Chart type* dropdown, then select the visualization type. +. Before you drag fields to the workspace, open the *Visualization type* dropdown, then select the visualization you want to use. . To view more visualizations that *Lens* automatically created for the fields, click *Suggestions*. If one of the *Suggestions* meets your visualization needs, click *Save and return* to add it to the dashboard. @@ -66,14 +66,14 @@ TIP: You can manually apply the changes you make, which is helpful when creating Change the fields list to display a different {data-source}, different time range, or add your own fields. -* To create a visualization with fields in a different {data-source}, open the *Data view* dropdown, then select the {data-source}. +* To create a visualization with fields in a different {data-source}, open the {data-source} dropdown, then select the {data-source}. * If the fields list is empty, change the <>. -* To add fields, open the action menu (*...*) next to the *Data view* dropdown, then select *Add field to {data-source}*. +* To add fields, open the {data-source} dropdown, then select *Add a field to this {data-source}*. + [role="screenshot"] -image:images/runtime-field-menu.png[Dropdown menu located next to {data-source} field with items for adding and managing fields, width=50%] +image:images/lens_dataViewDropDown_8.3.png[Dropdown menu located next to {data-source} field with items for adding and managing fields] + For more information about adding fields to {data-sources} and examples, refer to <>. @@ -83,7 +83,7 @@ For more information about adding fields to {data-sources} and examples, refer t Tables are highly customizable, and provide you with text alignment, value formatting, coloring options, and more. -. From the *Chart type* dropdown, select *Table*. +. From the *Visualization type* dropdown, select *Table*. . Drag the fields you want to visualize to the workspace. @@ -91,9 +91,9 @@ Tables are highly customizable, and provide you with text alignment, value forma + All columns that belong to the same layer pane group are sorted in the table. -. To change the display options, click a *Metrics* field, then configure the following options: +. To change the display options, click a *Metrics* field in the layer pane, then configure the following options: -* *Display name* — Specifies the field display name. +* *Name* — Specifies the field display name. * *Value format* — Specifies how the field value displays in the table. @@ -111,9 +111,6 @@ All columns that belong to the same layer pane group are sorted in the table. To use a keyboard instead of a mouse, use the *Lens* fully accessible and continuously improved drag system. -[role="screenshot"] -image::images/lens_drag_drop_1.gif[Presented Lens drag and drop] - . Select the field in the fields list or layer pane. Most fields have an inner and outer select state. The inner state opens a panel with detailed information or options. The outer state allows you to drag the field. Tab through the fields until you get the outer state on the field. + @@ -197,7 +194,13 @@ image::images/lens_annotations_8.2.0.png[Lens annotations] . To open the annotation options, click *Event*. -. Specify the *Annotation date*, then change the *Appearance* options you want to display. +. Specify the *Annotation date*. + +. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* time range. + +. Enter the annotation *Name*. + +. Change the *Appearance* options for how you want the annotation to display. . Click *Close*. diff --git a/docs/user/dashboard/make-dashboards-interactive.asciidoc b/docs/user/dashboard/make-dashboards-interactive.asciidoc index 0e20237c2ebc0..7c80fa8588538 100644 --- a/docs/user/dashboard/make-dashboards-interactive.asciidoc +++ b/docs/user/dashboard/make-dashboards-interactive.asciidoc @@ -172,12 +172,14 @@ To use saved search interactions, open the panel menu, then click *More > View s Panels have built-in interactive capabilities that apply filters to the dashboard data. For example, when you drag a time range or click a pie slice, a filter for the time range or pie slice is applied. Drilldowns let you customize the interactive behavior while keeping the context of the interaction. -There are two types of drilldowns you can add to dashboards: +There are three types of drilldowns you can add to dashboards: -* *Dashboard* — Navigates you from one dashboard to another dashboard. For example, when can create a drilldown for a *Lens* panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name. +* *Dashboard* — Navigates you from one dashboard to another dashboard. For example, create a drilldown for a *Lens* panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name. * *URL* — Navigates you from a dashboard to an external website. For example, a website with the specific host name as a parameter. +* *Discover* — Navigates you from a *Lens* dashboard panel to *Discover*. For example, create a drilldown for a *Lens* visualization that opens the visualization data in *Discover* for further exploration. + Third-party developers can create drilldowns. To learn how to code drilldowns, refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin]. [float] @@ -189,7 +191,7 @@ Dashboard drilldowns enable you to open a dashboard from another dashboard, taki For example, if you have a dashboard that shows the logs and metrics for multiple data centers, you can create a drilldown that navigates from the dashboard that shows multiple data centers, to a dashboard that shows a single data center or server. [role="screenshot"] -image:images/drilldown_on_data_table.gif[Drilldown on data table that navigates to another dashboard] +image:images/dashboard_drilldownOnDataTable_8.3.gif[Drilldown on data table that navigates to another dashboard] The panels you create using the following editors support dashboard drilldowns: @@ -220,7 +222,7 @@ Use the <> data to create a dashboard + [%hardbreaks] Search: `extension.keyword: ("gz" or "css" or "deb")` -Filter: `geo.src: CN` +Filter: `geo.src: US` [float] ===== Create the dashboard drilldown @@ -244,7 +246,7 @@ Create a drilldown that opens the *Detailed logs* dashboard from the *[Logs] Web . In the data table panel, hover over a value, click *+*, then select `View details`. + [role="screenshot"] -image::images/drilldown_on_panel.png[Drilldown on data table that navigates to another dashboard] +image::images/dashboard_drilldownOnPanel_8.3.png[Drilldown on data table that navigates to another dashboard] [float] [[url-drilldowns]] @@ -253,7 +255,7 @@ image::images/drilldown_on_panel.png[Drilldown on data table that navigates to a URL drilldowns enable you to navigate from a dashboard to external websites. Destination URLs can be dynamic, depending on the dashboard context or user interaction with a panel. To create URL drilldowns, you add <> to a URL template, which configures the behavior of the drilldown. All panels that you create with the visualization editors support dashboard drilldowns. [role="screenshot"] -image:images/url_drilldown_go_to_github.gif[Drilldown on pie chart that navigates to Github] +image:images/dashboard_urlDrilldownGoToGitHub_8.3.gif[Drilldown on pie chart that navigates to Github] Some panels support multiple interactions, also known as triggers. The <> you use to create a <> depends on the trigger you choose. URL drilldowns support these types of triggers: @@ -269,7 +271,7 @@ For example, *Single click* has `{{event.value}}` and *Range selection* has `{{e For example, if you have a dashboard that shows data from a Github repository, you can create a URL drilldown that opens Github from the dashboard panel. -. Add the *Sample web logs* data. +. Add the <> data. . Open the *[Logs] Web Traffic* dashboard. @@ -277,13 +279,11 @@ For example, if you have a dashboard that shows data from a Github repository, y . Create a donut chart -.. In the toolbar, click *Edit*. - .. Click *Create visualization*. .. From the *Chart type* dropdown, select *Donut*. -.. From the *Available fields* list, drag and drop the *machine.os.keyword* field onto the visualization builder. +.. From the *Available fields* list, drag *machine.os.keyword* to the workspace. .. Click *Save and return*. @@ -311,12 +311,47 @@ https://github.com/elastic/kibana/issues?q=is:issue+is:open+{{event.value}} . On the donut chart panel, click any chart slice, then select *Show on Github*. + [role="screenshot"] -image:images/url_drilldown_popup.png[URL drilldown popup] +image:images/dashboard_urlDrilldownPopup_8.3.png[URL drilldown popup] . In the list of {kib} repository issues, verify that the slice value appears. + [role="screenshot"] -image:images/url_drilldown_github.png[Github] +image:images/dashboard_urlDrilldownGithub_8.3.png[Open ios issues in the elastic/kibana repository on Github] + +[float] +[[discover-drilldowns]] +==== Create Discover drilldowns + +Discover drilldowns enable you to open *Discover* from a *Lens* dashboard panel, taking the time range, filters, and other parameters with you so the context remains the same. + +For example, when you create a Discover drilldown for a pie chart, you can click a slice in the pie chart, and only the documents for the slice appear in *Discover*. + +[role="screenshot"] +image:images/dashboard_discoverDrilldown_8.3.gif[Drilldown on bar vertical stacked chart that navigates to Discover] + +NOTE: Discover drilldowns are supported only by *Lens* panels. To open all of the *Lens* dashboard panel data in *Discover*, check <>. + +[float] +===== Create the Discover drilldown + +Create a drilldown that opens *Discover* from the <> data *[Logs] Web Traffic* dashboard. + +. Click *Edit*, open the panel menu for the *[Logs] Bytes distribution* bar vertical stacked chart, then select *Create drilldown*. + +. Click *Open in Discover*. + +. Give the drilldown a name. For example, `View bytes distribution in Discover`. + +. To open the Discover drilldown in a new tab, select *Open in new tab*. + +. Click *Create drilldown*. + +. Save the dashboard. + +. On the *[Logs] Bytes distribution* bar vertical stacked chart, click a bar, then select *View bytes distribution in Discover*. ++ +[role="screenshot"] +image::images/dashboard_discoverDrilldown_8.3.png[Drilldown on bar vertical stacked chart that navigates to Discover] [float] [[manage-drilldowns]] diff --git a/docs/user/dashboard/timelion.asciidoc b/docs/user/dashboard/timelion.asciidoc index 19962d11f7335..7e5b753973ea2 100644 --- a/docs/user/dashboard/timelion.asciidoc +++ b/docs/user/dashboard/timelion.asciidoc @@ -13,8 +13,6 @@ The syntax enables some features that classical point series charts don't offer, [role="screenshot"] image:dashboard/images/timelion.png[Timelion] -deprecated::[7.0.0,"*Timelion* is still supported. The *Timelion app* is deprecated in 7.0, replaced by dashboard features. In 7.16 and later, the *Timelion app* is removed from {kib}. To prepare for the removal of *Timelion app*, you must migrate *Timelion app* worksheets to a dashboard. For information on how to migrate *Timelion app* worksheets, refer to <>."] - [float] ==== Timelion expressions diff --git a/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc b/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc index 7437eb480e73f..1d4d5d70e879e 100644 --- a/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc +++ b/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc @@ -8,7 +8,7 @@ at website logs, but this type of dashboard works on any type of data. When you're done, you'll have a complete overview of the sample web logs data. [role="screenshot"] -image::images/lens_logsDashboard_7.16.png[Logs dashboard] +image::images/lens_logsDashboard_8.3.png[Logs dashboard] Before you begin, you should be familiar with the <>. @@ -38,10 +38,10 @@ Open the visualization editor, then make sure the correct fields appear. . On the dashboard, click *Create visualization*. -. Make sure the *kibana_sample_data_logs* index appears. +. Make sure the *kibana_sample_data_logs* data view appears. + [role="screenshot"] -image::images/lens_dataViewDropDown_8.0.png[Data view dropdown] +image::images/lens_dataViewDropDown_8.3.png[Data view dropdown] To create the visualizations in this tutorial, you'll use the following fields: @@ -79,12 +79,9 @@ In the layer pane, *Unique count of clientip* appears because the editor automat . In the layer pane, click *Unique count of clientip*. -.. In the *Display name* field, enter `Unique visitors`. +.. In the *Name* field, enter `Unique visitors`. .. Click *Close*. -+ -[role="screenshot"] -image::images/lens_metricUniqueVisitors_7.16.png[Metric visualization that displays number of unique visitors] . Click *Save and return*. + @@ -122,23 +119,21 @@ To increase the minimum time interval: . In the layer pane, click *timestamp*. -. Select *Customize time interval*. - -. Change the *Minimum interval* to *1 days*, then click *Close*. +. Change the *Minimum interval* to *1d*, then click *Close*. + -You can increase and decrease the minimum interval, but you are unable to decrease the interval below the <>. +You can increase and decrease the minimum interval, but you are unable to decrease the interval below the configured <>. To save space on the dashboard, hide the axis labels. -. Open the *Left axis* menu, then deselect *Show*. +. Open the *Left axis* menu, then select *None* from the *Axis title* dropdown. + [role="screenshot"] -image::images/lens_leftAxisMenu_7.16.png[Left axis menu] +image::images/lens_lineChartMetricOverTimeLeftAxis_8.3.png[Left axis menu] -. Open the *Bottom axis* menu, then deselect *Show*. +. Open the *Bottom axis* menu, then select *None* from the *Axis title* dropdown. + [role="screenshot"] -image::images/lens_lineChartMetricOverTime_7.16.png[Line chart that displays metric data over time] +image::images/lens_lineChartMetricOverTimeBottomAxis_8.3.png[Line chart that displays metric data over time] . Click *Save and return* @@ -183,7 +178,7 @@ image::images/lens_end_to_end_2_1_2.png[Table with top values of request.keyword .. In the *Number of values* field, enter `10`. -.. In the *Display name* field, enter `Page URL`. +.. In the *Name* field, enter `Page URL`. .. Click *Close*. + @@ -204,7 +199,9 @@ Create a proportional visualization that helps you determine if your users trans . From the *Available fields* list, drag *bytes* to the *Vertical axis* field in the layer pane. -. Click *Median of bytes*, click the *Sum* function, then click *Close*. +. In the layer pane, click *Median of bytes*. + +. Click the *Sum* function, then click *Close*. . From the *Available fields* list, drag *bytes* to the *Break down by* field in the layer pane. @@ -261,7 +258,7 @@ The distribution of a number can help you find patterns. For example, you can an .. Click the *Sum* function. -.. In the *Display name* field, enter `Transferred bytes`. +.. In the *Name* field, enter `Transferred bytes`. .. From the *Value format* dropdown, select *Bytes (1024)*, then click *Close*. @@ -292,11 +289,11 @@ Add a panel title: . From the *Available fields* list, drag *Records* to the *Size by* field in the layer pane. -. In the editor, click *Add or drag-and-drop a field* for *Group by*. +. In the layer pane, click *Add or drag-and-drop a field* for *Group by*. Create a filter for each website traffic source: -. From *Select a function*, click *Filters*. +. Click the *Filters* function. . Click *All records*, enter the following in the query bar, then press Return: @@ -331,7 +328,7 @@ Remove the documents that do not match the filter criteria: . In the layer pane, click *Top values of geo.srcdest*. -. Click *Advanced*, then deselect *Group other values as "Other"*, the click *Close*. +. Click *Advanced*, deselect *Group other values as "Other"*, then click *Close*. + [role="screenshot"] image::images/lens_treemapMultiLevelChart_7.16.png[Treemap visualization] @@ -361,7 +358,7 @@ Decrease the size of the following panels, then move the panels to the first row * *Website traffic* + [role="screenshot"] -image::images/lens_logsDashboard_7.16.png[Logs dashboard] +image::images/lens_logsDashboard_8.3.png[Logs dashboard] [discrete] === Save the dashboard diff --git a/examples/search_examples/public/search_sessions/app.tsx b/examples/search_examples/public/search_sessions/app.tsx index 31ffcc2b9a0f3..5fe519f005bf0 100644 --- a/examples/search_examples/public/search_sessions/app.tsx +++ b/examples/search_examples/public/search_sessions/app.tsx @@ -34,6 +34,7 @@ import { lastValueFrom, of } from 'rxjs'; import { CoreStart } from '@kbn/core/public'; import { mountReactNode } from '@kbn/core/public/utils'; +import type { TimeRange } from '@kbn/es-query'; import { NavigationPublicPluginStart } from '@kbn/navigation-plugin/public'; import { @@ -45,7 +46,6 @@ import { isErrorResponse, QueryState, SearchSessionState, - TimeRange, } from '@kbn/data-plugin/public'; import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; import type { DataView, DataViewField } from '@kbn/data-views-plugin/public'; diff --git a/examples/search_examples/public/search_sessions/app_locator.ts b/examples/search_examples/public/search_sessions/app_locator.ts index c7f805ed0d5f2..8fb1f15f12f9b 100644 --- a/examples/search_examples/public/search_sessions/app_locator.ts +++ b/examples/search_examples/public/search_sessions/app_locator.ts @@ -7,8 +7,7 @@ */ import { SerializableRecord } from '@kbn/utility-types'; -import { Filter, Query, isFilterPinned } from '@kbn/es-query'; -import type { TimeRange } from '@kbn/data-plugin/public'; +import { Filter, Query, isFilterPinned, TimeRange } from '@kbn/es-query'; import { getStatesFromKbnUrl, setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public'; import { LocatorDefinition } from '@kbn/share-plugin/common'; diff --git a/examples/state_containers_examples/public/with_data_services/app.tsx b/examples/state_containers_examples/public/with_data_services/app.tsx index b61e1fe98f83b..04d41cb6aa6a5 100644 --- a/examples/state_containers_examples/public/with_data_services/app.tsx +++ b/examples/state_containers_examples/public/with_data_services/app.tsx @@ -18,14 +18,13 @@ import { EuiText, EuiTitle, } from '@elastic/eui'; -import { Filter, FilterStateStore } from '@kbn/es-query'; +import { Filter, FilterStateStore, Query } from '@kbn/es-query'; import { CoreStart } from '@kbn/core/public'; import { NavigationPublicPluginStart } from '@kbn/navigation-plugin/public'; import { connectToQueryState, DataPublicPluginStart, - Query, QueryState, syncQueryStateWithUrl, } from '@kbn/data-plugin/public'; diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json index 7b066bf357d32..a8632e18a9848 100644 --- a/nav-kibana-dev.docnav.json +++ b/nav-kibana-dev.docnav.json @@ -100,6 +100,9 @@ { "label": "Tutorials", "items": [ + { + "id": "kibDevTutorialSetupWindowsDevWSL" + }, { "id": "kibDevTutorialTestingPlugins" }, @@ -519,4 +522,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/package.json b/package.json index fd4892f5d53d0..57492fc0c6b6a 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,6 @@ "debug": "node --nolazy --inspect scripts/kibana --dev", "debug-break": "node --nolazy --inspect-brk scripts/kibana --dev", "dev-docs": "scripts/dev_docs.sh", - "docs:acceptApiChanges": "node --max-old-space-size=6144 scripts/check_published_api_changes.js --accept", "es": "node scripts/es", "preinstall": "node ./preinstall_check", "kbn": "node scripts/kbn", @@ -210,6 +209,8 @@ "@kbn/server-route-repository": "link:bazel-bin/packages/kbn-server-route-repository", "@kbn/shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution", "@kbn/shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen", + "@kbn/shared-ux-button-toolbar": "link:bazel-bin/packages/shared-ux/button_toolbar", + "@kbn/shared-ux-card-no-data": "link:bazel-bin/packages/shared-ux/card/no_data", "@kbn/shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components", "@kbn/shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app", "@kbn/shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data", @@ -749,6 +750,8 @@ "@types/kbn__server-route-repository": "link:bazel-bin/packages/kbn-server-route-repository/npm_module_types", "@types/kbn__shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution/npm_module_types", "@types/kbn__shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/npm_module_types", + "@types/kbn__shared-ux-button-toolbar": "link:bazel-bin/packages/shared-ux/button_toolbar/npm_module_types", + "@types/kbn__shared-ux-card-no-data": "link:bazel-bin/packages/shared-ux/card/no_data/npm_module_types", "@types/kbn__shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components/npm_module_types", "@types/kbn__shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app/npm_module_types", "@types/kbn__shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data/npm_module_types", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index 9bcf6572cdc08..6c65af1a97e91 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -144,7 +144,9 @@ filegroup( "//packages/kbn-utility-types:build", "//packages/kbn-utils:build", "//packages/shared-ux/avatar/solution:build", + "//packages/shared-ux/button_toolbar:build", "//packages/shared-ux/button/exit_full_screen:build", + "//packages/shared-ux/card/no_data:build", "//packages/shared-ux/link/redirect_app:build", "//packages/shared-ux/page/analytics_no_data:build", "//packages/shared-ux/page/kibana_no_data:build", @@ -276,7 +278,9 @@ filegroup( "//packages/kbn-utility-types:build_types", "//packages/kbn-utils:build_types", "//packages/shared-ux/avatar/solution:build_types", + "//packages/shared-ux/button_toolbar:build_types", "//packages/shared-ux/button/exit_full_screen:build_types", + "//packages/shared-ux/card/no_data:build_types", "//packages/shared-ux/link/redirect_app:build_types", "//packages/shared-ux/page/analytics_no_data:build_types", "//packages/shared-ux/page/kibana_no_data:build_types", diff --git a/packages/kbn-bazel-packages/src/bazel_package_dirs.ts b/packages/kbn-bazel-packages/src/bazel_package_dirs.ts index a23b54317454a..5c0bfb5d4595b 100644 --- a/packages/kbn-bazel-packages/src/bazel_package_dirs.ts +++ b/packages/kbn-bazel-packages/src/bazel_package_dirs.ts @@ -21,6 +21,7 @@ import { REPO_ROOT } from '@kbn/utils'; */ export const BAZEL_PACKAGE_DIRS = [ 'packages', + 'packages/shared-ux', 'packages/shared-ux/*', 'packages/analytics', 'packages/analytics/shippers', diff --git a/packages/kbn-es-query/src/es_query/build_es_query.test.ts b/packages/kbn-es-query/src/es_query/build_es_query.test.ts index 8fd884f65fa0d..a75c8d3d3a03f 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.test.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.test.ts @@ -202,5 +202,60 @@ describe('build query', () => { expect(result).toEqual(expectedResult); }); + + it('should allow to use ignore_unmapped for nested fields', () => { + const queries = [ + { query: 'nestedField: { child: "something" }', language: 'kuery' }, + ] as Query[]; + + const filters = [ + { + query: { exists: { field: 'nestedField.child' } }, + meta: { type: 'exists', alias: '', disabled: false, negate: false }, + }, + ]; + + const result = buildEsQuery(indexPattern, queries, filters, { nestedIgnoreUnmapped: true }); + const expected = { + bool: { + must: [], + filter: [ + { + nested: { + ignore_unmapped: true, + path: 'nestedField', + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + 'nestedField.child': 'something', + }, + }, + ], + }, + }, + score_mode: 'none', + }, + }, + { + nested: { + path: 'nestedField', + query: { + exists: { + field: 'nestedField.child', + }, + }, + ignore_unmapped: true, + }, + }, + ], + should: [], + must_not: [], + }, + }; + expect(result).toEqual(expected); + }); }); }); diff --git a/packages/kbn-es-query/src/es_query/build_es_query.ts b/packages/kbn-es-query/src/es_query/build_es_query.ts index 0ae0b8799b026..62172fa5aa4d8 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.ts @@ -13,17 +13,18 @@ import { buildQueryFromFilters } from './from_filters'; import { buildQueryFromLucene } from './from_lucene'; import { Filter, Query } from '../filters'; import { BoolQuery, DataViewBase } from './types'; -import { KueryQueryOptions } from '../kuery'; +import type { KueryQueryOptions } from '../kuery'; +import type { EsQueryFiltersConfig } from './from_filters'; /** * Configurations to be used while constructing an ES query. * @public */ -export type EsQueryConfig = KueryQueryOptions & { - allowLeadingWildcards: boolean; - queryStringOptions: SerializableRecord; - ignoreFilterIfFieldNotInIndex: boolean; -}; +export type EsQueryConfig = KueryQueryOptions & + EsQueryFiltersConfig & { + allowLeadingWildcards?: boolean; + queryStringOptions?: SerializableRecord; + }; function removeMatchAll(filters: T[]) { return filters.filter( @@ -59,20 +60,23 @@ export function buildEsQuery( const kueryQuery = buildQueryFromKuery( indexPattern, queriesByLanguage.kuery, - config.allowLeadingWildcards, - config.dateFormatTZ, - config.filtersInMustClause + { allowLeadingWildcards: config.allowLeadingWildcards }, + { + dateFormatTZ: config.dateFormatTZ, + filtersInMustClause: config.filtersInMustClause, + nestedIgnoreUnmapped: config.nestedIgnoreUnmapped, + } ); const luceneQuery = buildQueryFromLucene( queriesByLanguage.lucene, config.queryStringOptions, config.dateFormatTZ ); - const filterQuery = buildQueryFromFilters( - filters, - indexPattern, - config.ignoreFilterIfFieldNotInIndex - ); + + const filterQuery = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: config.ignoreFilterIfFieldNotInIndex, + nestedIgnoreUnmapped: config.nestedIgnoreUnmapped, + }); return { bool: { diff --git a/packages/kbn-es-query/src/es_query/from_filters.test.ts b/packages/kbn-es-query/src/es_query/from_filters.test.ts index 67de9e4d88736..78b719ccc0e62 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.test.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.test.ts @@ -19,7 +19,9 @@ describe('build query', () => { describe('buildQueryFromFilters', () => { test('should return the parameters of an Elasticsearch bool query', () => { - const result = buildQueryFromFilters([], indexPattern, false); + const result = buildQueryFromFilters([], indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); const expected = { must: [], filter: [], @@ -43,7 +45,9 @@ describe('build query', () => { const expectedESQueries = [{ match_all: {} }, { exists: { field: 'foo' } }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -55,14 +59,18 @@ describe('build query', () => { meta: { type: 'match_all', negate: true, disabled: true }, } as MatchAllFilter, ] as Filter[]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual([]); }); test('should remove falsy filters', () => { const filters = [null, undefined] as unknown as Filter[]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual([]); expect(result.must).toEqual([]); @@ -78,7 +86,9 @@ describe('build query', () => { const expectedESQueries = [{ match_all: {} }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual(expectedESQueries); }); @@ -97,7 +107,9 @@ describe('build query', () => { }, ]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -116,7 +128,9 @@ describe('build query', () => { }, ]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -130,7 +144,9 @@ describe('build query', () => { ] as Filter[]; const expectedESQueries = [{ query_string: { query: 'foo' } }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -159,5 +175,31 @@ describe('build query', () => { const result = buildQueryFromFilters(filters, indexPattern); expect(result.filter).toEqual(expectedESQueries); }); + + test('should allow to configure ignore_unmapped for filters targeting nested fields in a nested query', () => { + const filters = [ + { + query: { exists: { field: 'nestedField.child' } }, + meta: { type: 'exists', alias: '', disabled: false, negate: false }, + }, + ]; + + const expectedESQueries = [ + { + nested: { + path: 'nestedField', + query: { + exists: { + field: 'nestedField.child', + }, + }, + ignore_unmapped: true, + }, + }, + ]; + + const result = buildQueryFromFilters(filters, indexPattern, { nestedIgnoreUnmapped: true }); + expect(result.filter).toEqual(expectedESQueries); + }); }); }); diff --git a/packages/kbn-es-query/src/es_query/from_filters.ts b/packages/kbn-es-query/src/es_query/from_filters.ts index e018cdc3404ad..871ff77026b54 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.ts @@ -38,6 +38,23 @@ const translateToQuery = (filter: Partial): estypes.QueryDslQueryContain return filter.query || filter; }; +/** + * Options for building query for filters + */ +export interface EsQueryFiltersConfig { + /** + * by default filters that use fields that can't be found in the specified index pattern are not applied. Set this to true if you want to apply them anyway. + */ + ignoreFilterIfFieldNotInIndex?: boolean; + + /** + * the nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error. + * The optional ignore_unmapped parameter defaults to false. + * This `nestedIgnoreUnmapped` param allows creating queries with "ignore_unmapped": true + */ + nestedIgnoreUnmapped?: boolean; +} + /** * @param filters * @param indexPattern @@ -49,7 +66,9 @@ const translateToQuery = (filter: Partial): estypes.QueryDslQueryContain export const buildQueryFromFilters = ( filters: Filter[] = [], indexPattern: DataViewBase | undefined, - ignoreFilterIfFieldNotInIndex: boolean = false + { ignoreFilterIfFieldNotInIndex = false, nestedIgnoreUnmapped }: EsQueryFiltersConfig = { + ignoreFilterIfFieldNotInIndex: false, + } ): BoolQuery => { filters = filters.filter((filter) => filter && !isFilterDisabled(filter)); @@ -63,7 +82,9 @@ export const buildQueryFromFilters = ( .map((filter) => { return migrateFilter(filter, indexPattern); }) - .map((filter) => handleNestedFilter(filter, indexPattern)) + .map((filter) => + handleNestedFilter(filter, indexPattern, { ignoreUnmapped: nestedIgnoreUnmapped }) + ) .map(cleanFilter) .map(translateToQuery); }; diff --git a/packages/kbn-es-query/src/es_query/from_kuery.test.ts b/packages/kbn-es-query/src/es_query/from_kuery.test.ts index 443b44dff5819..60bdb54858240 100644 --- a/packages/kbn-es-query/src/es_query/from_kuery.test.ts +++ b/packages/kbn-es-query/src/es_query/from_kuery.test.ts @@ -22,7 +22,7 @@ describe('build query', () => { describe('buildQueryFromKuery', () => { test('should return the parameters of an Elasticsearch bool query', () => { - const result = buildQueryFromKuery(undefined, [], true); + const result = buildQueryFromKuery(undefined, [], { allowLeadingWildcards: true }); const expected = { must: [], filter: [], @@ -42,7 +42,7 @@ describe('build query', () => { return toElasticsearchQuery(fromKueryExpression(query.query), indexPattern); }); - const result = buildQueryFromKuery(indexPattern, queries, true); + const result = buildQueryFromKuery(indexPattern, queries, { allowLeadingWildcards: true }); expect(result.filter).toEqual(expectedESQueries); }); @@ -55,7 +55,14 @@ describe('build query', () => { }); }); - const result = buildQueryFromKuery(indexPattern, queries, true, 'America/Phoenix'); + const result = buildQueryFromKuery( + indexPattern, + queries, + { allowLeadingWildcards: true }, + { + dateFormatTZ: 'America/Phoenix', + } + ); expect(result.filter).toEqual(expectedESQueries); }); @@ -68,7 +75,7 @@ describe('build query', () => { return toElasticsearchQuery(fromKueryExpression(query.query), indexPattern); }); - const result = buildQueryFromKuery(indexPattern, queries, true); + const result = buildQueryFromKuery(indexPattern, queries, { allowLeadingWildcards: true }); expect(result.filter).toEqual(expectedESQueries); }); diff --git a/packages/kbn-es-query/src/es_query/from_kuery.ts b/packages/kbn-es-query/src/es_query/from_kuery.ts index 3bb5d45fc53e3..6a1254a6e5037 100644 --- a/packages/kbn-es-query/src/es_query/from_kuery.ts +++ b/packages/kbn-es-query/src/es_query/from_kuery.ts @@ -6,30 +6,42 @@ * Side Public License, v 1. */ -import { SerializableRecord } from '@kbn/utility-types'; import { Query } from '../filters'; -import { fromKueryExpression, toElasticsearchQuery, nodeTypes, KueryNode } from '../kuery'; +import { + fromKueryExpression, + toElasticsearchQuery, + nodeTypes, + KueryNode, + KueryQueryOptions, +} from '../kuery'; import { BoolQuery, DataViewBase } from './types'; /** @internal */ export function buildQueryFromKuery( indexPattern: DataViewBase | undefined, queries: Query[] = [], - allowLeadingWildcards: boolean = false, - dateFormatTZ?: string, - filtersInMustClause: boolean = false + { allowLeadingWildcards = false }: { allowLeadingWildcards?: boolean } = { + allowLeadingWildcards: false, + }, + { filtersInMustClause = false, dateFormatTZ, nestedIgnoreUnmapped }: KueryQueryOptions = { + filtersInMustClause: false, + } ): BoolQuery { const queryASTs = queries.map((query) => { return fromKueryExpression(query.query, { allowLeadingWildcards }); }); - return buildQuery(indexPattern, queryASTs, { dateFormatTZ, filtersInMustClause }); + return buildQuery(indexPattern, queryASTs, { + filtersInMustClause, + dateFormatTZ, + nestedIgnoreUnmapped, + }); } function buildQuery( indexPattern: DataViewBase | undefined, queryASTs: KueryNode[], - config: SerializableRecord = {} + config: KueryQueryOptions = {} ): BoolQuery { const compoundQueryAST = nodeTypes.function.buildNode('and', queryASTs); const kueryQuery = toElasticsearchQuery(compoundQueryAST, indexPattern, config); diff --git a/packages/kbn-es-query/src/es_query/from_lucene.ts b/packages/kbn-es-query/src/es_query/from_lucene.ts index d00614b31347f..9f72f3bf0ef6e 100644 --- a/packages/kbn-es-query/src/es_query/from_lucene.ts +++ b/packages/kbn-es-query/src/es_query/from_lucene.ts @@ -15,7 +15,7 @@ import { BoolQuery } from './types'; /** @internal */ export function buildQueryFromLucene( queries: Query[], - queryStringOptions: SerializableRecord, + queryStringOptions: SerializableRecord = {}, dateFormatTZ?: string ): BoolQuery { const combinedQueries = (queries || []).map((query) => { diff --git a/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts b/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts index 2b9fbbe5ece04..01ce78dfbab9f 100644 --- a/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts +++ b/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts @@ -39,6 +39,28 @@ describe('handleNestedFilter', function () { }); }); + it('should allow to configure ignore_unmapped', () => { + const field = getField('nestedField.child'); + const filter = buildPhraseFilter(field!, 'foo', indexPattern); + const result = handleNestedFilter(filter, indexPattern, { ignoreUnmapped: true }); + expect(result).toEqual({ + meta: { + index: 'logstash-*', + }, + query: { + nested: { + path: 'nestedField', + query: { + match_phrase: { + 'nestedField.child': 'foo', + }, + }, + ignore_unmapped: true, + }, + }, + }); + }); + it('should return filter untouched if it does not target a nested field', () => { const field = getField('extension'); const filter = buildPhraseFilter(field!, 'jpg', indexPattern); diff --git a/packages/kbn-es-query/src/es_query/handle_nested_filter.ts b/packages/kbn-es-query/src/es_query/handle_nested_filter.ts index 14138ca44d310..fb32d55e53a7e 100644 --- a/packages/kbn-es-query/src/es_query/handle_nested_filter.ts +++ b/packages/kbn-es-query/src/es_query/handle_nested_filter.ts @@ -11,7 +11,11 @@ import { DataViewBase } from './types'; import { getDataViewFieldSubtypeNested } from '../utils'; /** @internal */ -export const handleNestedFilter = (filter: Filter, indexPattern?: DataViewBase) => { +export const handleNestedFilter = ( + filter: Filter, + indexPattern?: DataViewBase, + config: { ignoreUnmapped?: boolean } = {} +) => { if (!indexPattern) return filter; const fieldName = getFilterField(filter); @@ -36,6 +40,9 @@ export const handleNestedFilter = (filter: Filter, indexPattern?: DataViewBase) nested: { path: subTypeNested.nested.path, query: query.query || query, + ...(typeof config.ignoreUnmapped === 'boolean' && { + ignore_unmapped: config.ignoreUnmapped, + }), }, }, }; diff --git a/packages/kbn-es-query/src/es_query/index.ts b/packages/kbn-es-query/src/es_query/index.ts index 399df50e35058..d4e45b35728f6 100644 --- a/packages/kbn-es-query/src/es_query/index.ts +++ b/packages/kbn-es-query/src/es_query/index.ts @@ -7,6 +7,7 @@ */ export { migrateFilter } from './migrate_filter'; +export type { EsQueryFiltersConfig } from './from_filters'; export type { EsQueryConfig } from './build_es_query'; export { buildEsQuery } from './build_es_query'; export { buildQueryFromFilters } from './from_filters'; diff --git a/packages/kbn-es-query/src/index.ts b/packages/kbn-es-query/src/index.ts index 5b0b0a4f1d3a9..aadec300b5610 100644 --- a/packages/kbn-es-query/src/index.ts +++ b/packages/kbn-es-query/src/index.ts @@ -11,6 +11,7 @@ export type { DataViewBase, DataViewFieldBase, EsQueryConfig, + EsQueryFiltersConfig, IFieldSubType, IFieldSubTypeMulti, IFieldSubTypeNested, diff --git a/packages/kbn-es-query/src/kuery/functions/is.test.ts b/packages/kbn-es-query/src/kuery/functions/is.test.ts index 2ec53629b9dca..1a8229a62fe2a 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.test.ts @@ -314,6 +314,32 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); + + test('should allow to configure ignore_unmapped for a nested query', () => { + const expected = { + bool: { + should: [ + { + nested: { + path: 'nestedField.nestedChild', + query: { + match: { + 'nestedField.nestedChild.doublyNestedChild': 'foo', + }, + }, + score_mode: 'none', + ignore_unmapped: true, + }, + }, + ], + minimum_should_match: 1, + }, + }; + const node = nodeTypes.function.buildNode('is', '*doublyNested*', 'foo'); + const result = is.toElasticsearchQuery(node, indexPattern, { nestedIgnoreUnmapped: true }); + + expect(result).toEqual(expected); + }); }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/is.ts b/packages/kbn-es-query/src/kuery/functions/is.ts index eeb9f139c9e52..fcf7dffabef86 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.ts @@ -114,6 +114,9 @@ export function toElasticsearchQuery( path: subTypeNested.nested.path, query, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/functions/nested.ts b/packages/kbn-es-query/src/kuery/functions/nested.ts index 18cd9794922c6..ea3ee1b4fc131 100644 --- a/packages/kbn-es-query/src/kuery/functions/nested.ts +++ b/packages/kbn-es-query/src/kuery/functions/nested.ts @@ -37,6 +37,9 @@ export function toElasticsearchQuery( nested: { path: fullPath }, }) as estypes.QueryDslQueryContainer, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/functions/range.test.ts b/packages/kbn-es-query/src/kuery/functions/range.test.ts index 575246724d6b2..9ff2fc54563b4 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.test.ts @@ -229,6 +229,36 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); + + test('should allow to configure ignore_unmapped for a nested query', () => { + const expected = { + bool: { + should: [ + { + nested: { + path: 'nestedField.nestedChild', + query: { + range: { + 'nestedField.nestedChild.doublyNestedChild': { + lt: 8000, + }, + }, + }, + score_mode: 'none', + ignore_unmapped: true, + }, + }, + ], + minimum_should_match: 1, + }, + }; + const node = nodeTypes.function.buildNode('range', '*doublyNested*', 'lt', 8000); + const result = range.toElasticsearchQuery(node, indexPattern, { + nestedIgnoreUnmapped: true, + }); + + expect(result).toEqual(expected); + }); }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/range.ts b/packages/kbn-es-query/src/kuery/functions/range.ts index 313f6571259a0..c355f02027e8e 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.ts @@ -66,6 +66,9 @@ export function toElasticsearchQuery( path: subTypeNested.nested.path, query, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/types.ts b/packages/kbn-es-query/src/kuery/types.ts index 7b35eb10ff7b8..7a6e7a9c6bf63 100644 --- a/packages/kbn-es-query/src/kuery/types.ts +++ b/packages/kbn-es-query/src/kuery/types.ts @@ -39,4 +39,11 @@ export { nodeTypes } from './node_types'; export interface KueryQueryOptions { filtersInMustClause?: boolean; dateFormatTZ?: string; + + /** + * the Nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error. + * The optional ignore_unmapped parameter defaults to false. + * The `nestedIgnoreUnmapped` param allows creating queries with "ignore_unmapped": true + */ + nestedIgnoreUnmapped?: boolean; } diff --git a/packages/kbn-shared-ux-components/BUILD.bazel b/packages/kbn-shared-ux-components/BUILD.bazel index 1a4a7100ded72..20d71557fef9a 100644 --- a/packages/kbn-shared-ux-components/BUILD.bazel +++ b/packages/kbn-shared-ux-components/BUILD.bazel @@ -45,6 +45,7 @@ RUNTIME_DEPS = [ "//packages/shared-ux/avatar/solution", "//packages/shared-ux/link/redirect_app", "//packages/shared-ux/prompt/no_data_views", + "//packages/shared-ux/card/no_data", "//packages/kbn-shared-ux-services", "//packages/kbn-shared-ux-storybook", "//packages/kbn-shared-ux-utility", @@ -74,6 +75,7 @@ TYPES_DEPS = [ "//packages/shared-ux/avatar/solution:npm_module_types", "//packages/shared-ux/link/redirect_app:npm_module_types", "//packages/shared-ux/prompt/no_data_views:npm_module_types", + "//packages/shared-ux/card/no_data:npm_module_types", "//packages/kbn-shared-ux-services:npm_module_types", "//packages/kbn-shared-ux-storybook:npm_module_types", "//packages/kbn-shared-ux-utility:npm_module_types", diff --git a/packages/kbn-shared-ux-components/src/index.ts b/packages/kbn-shared-ux-components/src/index.ts index 68772ed90121c..970e584d95782 100644 --- a/packages/kbn-shared-ux-components/src/index.ts +++ b/packages/kbn-shared-ux-components/src/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -export { ToolbarButton, IconButtonGroup, AddFromLibraryButton, ToolbarPopover } from './toolbar'; export { KibanaPageTemplateSolutionNav } from './page_template/solution_nav'; // TODO: clintandrewhall - NoDataPageProps is a temporary addition until it is split into its own package diff --git a/packages/kbn-shared-ux-components/src/page_template/index.ts b/packages/kbn-shared-ux-components/src/page_template/index.ts index 671f720972fc9..cd7d6232d9a8b 100644 --- a/packages/kbn-shared-ux-components/src/page_template/index.ts +++ b/packages/kbn-shared-ux-components/src/page_template/index.ts @@ -5,7 +5,7 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -export { NoDataCard, ElasticAgentCard, NoDataPage, NoDataConfigPage } from './no_data_page'; +export { NoDataPage, NoDataConfigPage } from './no_data_page'; export { KibanaPageTemplate } from './page_template'; export type { KibanaPageTemplateProps } from './types'; export type { NoDataPageProps } from './no_data_page'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/__snapshots__/no_data_page.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/__snapshots__/no_data_page.test.tsx.snap deleted file mode 100644 index 5fd29bc57b331..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/__snapshots__/no_data_page.test.tsx.snap +++ /dev/null @@ -1,55 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`NoDataPage render 1`] = ` -

- - - -

- Welcome to Elastic Analytics! -

- -

- - - , - "solution": "Analytics", - } - } - /> -

- - - - -
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts index 894097727cd1f..a6f8c91f7614c 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -export { NoDataCard, ElasticAgentCard } from './no_data_card'; export { NoDataPage } from './no_data_page'; export type { NoDataPageProps } from './types'; export { NoDataConfigPage, NoDataConfigPageWithSolutionNavBar } from './no_data_config_page'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap deleted file mode 100644 index c871196b92282..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap +++ /dev/null @@ -1,104 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`ElasticAgentCardComponent props button 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent props href 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent renders 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent renders with canAccessFleet false 1`] = ` - - This integration is not yet enabled. Your administrator has the required permissions to turn it on. - - } - image={ - - } - isDisabled={true} - title={ - - Contact your administrator - - } -/> -`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap deleted file mode 100644 index dbdb652a10c1f..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap +++ /dev/null @@ -1,75 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`ElasticAgentCard renders 1`] = ` -
-
-
-
-
- -
-
-
-
- - - - Add Elastic Agent - - - -
-

- Use Elastic Agent for a simple, unified way to collect data from your machines. -

-
-
-
- -
-
-
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap deleted file mode 100644 index 0028d505e9187..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap +++ /dev/null @@ -1,231 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`NoDataCard props button 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props extends EuiCardProps 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props href 1`] = ` -
-
- - - - Card title - - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props isDisabled 1`] = ` -
-
- - - -
-

- Description -

-
-
-
-`; - -exports[`NoDataCard renders 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx deleted file mode 100644 index 367fcd10b96a9..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { shallow } from 'enzyme'; -import React from 'react'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; -import { NoDataCard } from './no_data_card'; - -describe('ElasticAgentCardComponent', () => { - test('renders', () => { - const component = shallow(); - expect(component).toMatchSnapshot(); - }); - - test('renders with canAccessFleet false', () => { - const component = shallow(); - expect(component.find(NoDataCard).props().isDisabled).toBe(true); - expect(component).toMatchSnapshot(); - }); - - describe('props', () => { - test('button', () => { - const component = shallow( - - ); - expect(component.find(NoDataCard).props().button).toBe('Button'); - expect(component).toMatchSnapshot(); - }); - - test('href', () => { - const component = shallow( - - ); - expect(component.find(NoDataCard).props().href).toBe('some path'); - expect(component).toMatchSnapshot(); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx deleted file mode 100644 index 31d0aad7cc631..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React, { FunctionComponent } from 'react'; -import { i18n } from '@kbn/i18n'; -import { EuiImage, EuiTextColor } from '@elastic/eui'; -import { ElasticAgentCardProps } from './types'; -import { NoDataCard } from './no_data_card'; -import ElasticAgentCardIllustration from './assets/elastic_agent_card.svg'; - -export type ElasticAgentCardComponentProps = ElasticAgentCardProps & { - canAccessFleet: boolean; -}; - -const noPermissionTitle = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title', - { - defaultMessage: `Contact your administrator`, - } -); - -const noPermissionDescription = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description', - { - defaultMessage: `This integration is not yet enabled. Your administrator has the required permissions to turn it on.`, - } -); - -const elasticAgentCardTitle = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.title', - { - defaultMessage: 'Add Elastic Agent', - } -); - -const elasticAgentCardDescription = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.description', - { - defaultMessage: `Use Elastic Agent for a simple, unified way to collect data from your machines.`, - } -); - -/** - * Creates a specific NoDataCard pointing users to Integrations when `canAccessFleet` - */ -export const ElasticAgentCardComponent: FunctionComponent = ({ - canAccessFleet, - title = elasticAgentCardTitle, - description, - ...cardRest -}) => { - const props = canAccessFleet - ? { - title, - description: description || elasticAgentCardDescription, - } - : { - title: {noPermissionTitle}, - description: {noPermissionDescription}, - isDisabled: true, - }; - - const image = ( - - ); - - return ; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx deleted file mode 100644 index a87da6ff9ca0e..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; - -import { - ElasticAgentCardComponent as Component, - ElasticAgentCardComponentProps as ComponentProps, -} from './elastic_agent_card.component'; - -import { ElasticAgentCard } from './elastic_agent_card'; - -export default { - title: 'Page Template/No Data/Elastic Agent Data Card', - description: 'A solution-specific wrapper around NoDataCard, to be used on NoData page', -}; - -type Params = Pick; - -export const PureComponent = (params: Params) => { - return ; -}; - -PureComponent.argTypes = { - canAccessFleet: { - control: 'boolean', - defaultValue: true, - }, - description: { - control: 'text', - defaultValue: '', - }, -}; - -export const ConnectedComponent = () => { - return ; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx deleted file mode 100644 index ed0b4471fa32c..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { ReactWrapper } from 'enzyme'; -import React from 'react'; -import { mountWithIntl } from '@kbn/test-jest-helpers'; -import { - SharedUxServicesProvider, - SharedUxServices, - mockServicesFactory, -} from '@kbn/shared-ux-services'; - -import { ElasticAgentCard } from './elastic_agent_card'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; - -describe('ElasticAgentCard', () => { - let services: SharedUxServices; - let mount: (element: JSX.Element) => ReactWrapper; - - beforeEach(() => { - services = mockServicesFactory(); - mount = (element: JSX.Element) => - mountWithIntl({element}); - }); - - afterEach(() => { - jest.resetAllMocks(); - }); - - test('renders', () => { - const component = mount(); - expect(component.render()).toMatchSnapshot(); - }); - - describe('href', () => { - test('returns href if href is given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe('/take/me/somewhere'); - }); - - test('returns prefix + category if href is not given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe( - '/app/integrations/browse/solutions' - ); - }); - - test('returns prefix if nor category nor href are given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe( - '/app/integrations/browse' - ); - }); - }); - - describe('description', () => { - test('renders custom description if provided', () => { - const component = mount( - - ); - expect(component.find(ElasticAgentCardComponent).props().description).toBe( - 'Build seamless search experiences faster.' - ); - }); - }); - - describe('canAccessFleet', () => { - test('passes in the right parameter', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().canAccessFleet).toBe(true); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx deleted file mode 100644 index a4025f33616ed..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React, { useMemo } from 'react'; -import { useApplication, useHttp, usePermissions } from '@kbn/shared-ux-services'; -import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app'; -import useObservable from 'react-use/lib/useObservable'; - -import { ElasticAgentCardProps } from './types'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; - -export const ElasticAgentCard = (props: ElasticAgentCardProps) => { - const { canAccessFleet } = usePermissions(); - const { addBasePath } = useHttp(); - const { navigateToUrl, currentAppId$ } = useApplication(); - const currentAppId = useObservable(currentAppId$); - - const { href: srcHref, category, description } = props; - - const href = useMemo(() => { - if (srcHref) { - return srcHref; - } - - // TODO: get this URL from a locator - const prefix = '/app/integrations/browse'; - - if (category) { - return addBasePath(`${prefix}/${category}`); - } - - return addBasePath(prefix); - }, [addBasePath, srcHref, category]); - - return ( - - - - ); -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts deleted file mode 100644 index e4cdeb401584f..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ -export { NoDataCard } from './no_data_card'; -export { ElasticAgentCard } from './elastic_agent_card'; -export type { NoDataCardProps, ElasticAgentCardProps } from './types'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx deleted file mode 100644 index 9c1b2d0322074..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { NoDataCard } from './no_data_card'; -import type { NoDataCardProps } from './types'; - -export default { - title: 'Page Template/No Data/No Data Card', - description: 'A wrapper around EuiCard, to be used on NoData page', -}; - -type Params = Pick; - -export const PureComponent = (params: Params) => { - return ; -}; - -PureComponent.argTypes = { - button: { - control: { - type: 'text', - }, - defaultValue: 'Button text', - }, - description: { - control: { - type: 'text', - }, - defaultValue: 'This is a description', - }, -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx deleted file mode 100644 index 6bbed463f23ed..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { render } from 'enzyme'; -import React from 'react'; -import { NoDataCard } from './no_data_card'; - -describe('NoDataCard', () => { - test('renders', () => { - const component = render(); - expect(component).toMatchSnapshot(); - }); - - describe('props', () => { - test('button', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('href', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('isDisabled', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('extends EuiCardProps', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx deleted file mode 100644 index 508d03d5028b8..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import React, { FunctionComponent } from 'react'; -import { EuiButton, EuiCard, EuiScreenReaderOnly } from '@elastic/eui'; - -import type { NoDataCardProps } from './types'; -import { NoDataCardStyles } from './no_data_card.styles'; - -const defaultDescription = i18n.translate( - 'sharedUXComponents.pageTemplate.noDataCard.description', - { - defaultMessage: `Proceed without collecting data`, - } -); - -export const NoDataCard: FunctionComponent = ({ - title: titleProp, - button, - description, - isDisabled, - ...cardRest -}) => { - const styles = NoDataCardStyles(); - - const footer = () => { - // Don't render the footer action if disabled - if (isDisabled) { - return; - } - // Render a custom footer action if the button is not a simple string - if (button && typeof button !== 'string') { - return button; - } - // Default footer action is a button with the provided or default string - return {button || titleProp}; - }; - - const cardDescription = description || defaultDescription; - - // Fix the need for an a11y title even though the button exists by setting to screen reader only - const title = titleProp ? ( - - {titleProp} - - ) : null; - - return ( - - ); -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts deleted file mode 100644 index fef4f654ce970..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { EuiCardProps } from '@elastic/eui'; -import { MouseEventHandler, ReactNode } from 'react'; - -export type NoDataCardProps = Partial> & { - /** - * Provide just a string for the button's label, or a whole component; - * The button will be hidden completely if `isDisabled=true` - */ - button?: string | ReactNode; - /** - * Remapping `onClick` to any element - */ - onClick?: MouseEventHandler; - /** - * Description for the card; - * If not provided, the default will be used - */ - description?: string | ReactNode; -}; - -export type ElasticAgentCardProps = NoDataCardProps & { - /** - * Category to auto-select within Fleet - */ - category?: string; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx index c84dea27552aa..b9474285469e1 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx @@ -7,24 +7,27 @@ */ import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; +import { NoDataCard } from '@kbn/shared-ux-card-no-data'; +import { SharedUxServicesProvider, mockServicesFactory } from '@kbn/shared-ux-services'; + import { NoDataPage } from './no_data_page'; -import { shallowWithIntl } from '@kbn/test-jest-helpers'; -import { ElasticAgentCard } from './no_data_card'; describe('NoDataPage', () => { test('render', () => { - const component = shallowWithIntl( - + const component = mountWithIntl( + + + ); - expect(component).toMatchSnapshot(); expect(component.find('h1').html()).toContain('Welcome to Elastic Analytics!'); - expect(component.find(ElasticAgentCard).length).toBe(1); + expect(component.find(NoDataCard).length).toBe(1); }); }); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx index 093a76d17759f..724570d4baccd 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx @@ -7,6 +7,7 @@ */ import React, { useMemo, FunctionComponent } from 'react'; +import useObservable from 'react-use/lib/useObservable'; import classNames from 'classnames'; import { EuiLink, EuiSpacer, EuiText, EuiTextColor } from '@elastic/eui'; @@ -14,7 +15,8 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { KibanaSolutionAvatar } from '@kbn/shared-ux-avatar-solution'; -import { ElasticAgentCard } from './no_data_card'; +import { useSharedUxServices } from '@kbn/shared-ux-services'; +import { NoDataCard, NoDataCardProvider } from '@kbn/shared-ux-card-no-data'; import { NoDataPageProps } from './types'; export const NoDataPage: FunctionComponent = ({ @@ -25,6 +27,19 @@ export const NoDataPage: FunctionComponent = ({ pageTitle, ...rest }) => { + const services = useSharedUxServices(); + + // TODO: clintandrewhall - including the `NoDataCardProvider` here is a temporary solution + // to consumers using this context to populate the NoDataPage. This will likely be removed soon, + // when NoDataPage is moved to its own package. + const currentAppId = useObservable(services.application.currentAppId$); + const noDataCardServices = { + currentAppId, + addBasePath: services.http.addBasePath, + canAccessFleet: services.permissions.canAccessFleet, + navigateToUrl: services.application.navigateToUrl, + }; + const actionKeys = Object.keys(action); const actionCard = useMemo(() => { @@ -34,7 +49,7 @@ export const NoDataPage: FunctionComponent = ({ const actionKey = actionKeys[0]; const key = actionKey === 'elasticAgent' ? 'empty-page-agent-action' : `empty-page-${actionKey}-action`; - return ; + return ; }, [action, actionKeys]); const title = @@ -74,7 +89,7 @@ export const NoDataPage: FunctionComponent = ({ - {actionCard} + {actionCard} ); }; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts index b304a1462a278..e22f7a7b81a77 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts @@ -7,9 +7,9 @@ */ import { CommonProps } from '@elastic/eui'; -import { ElasticAgentCardProps } from './no_data_card'; +import { NoDataCardProps } from '@kbn/shared-ux-card-no-data'; -export type NoDataPageActions = ElasticAgentCardProps; +export type NoDataPageActions = NoDataCardProps; export interface NoDataPageProps extends CommonProps { /** diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap b/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap deleted file mode 100644 index 520184f0f96dc..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap +++ /dev/null @@ -1,76 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[` is rendered 1`] = ` - - - - - - - - - -`; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.mdx b/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.mdx deleted file mode 100644 index f6a2f92cd41eb..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: sharedUX/Components/AddFromLibraryButton -slug: /shared-ux/components/toolbar/buttons/add_from_library -title: Add From Library Button -summary: An example of the primary button -tags: ['shared-ux', 'component'] -date: 2022-03-18 ---- - -This button is an example of the primary button. diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.stories.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.stories.tsx deleted file mode 100644 index ea50431545028..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.stories.tsx +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { AddFromLibraryButton } from './add_from_library'; -import mdx from './add_from_library.mdx'; - -export default { - title: 'Toolbar/Buttons/Add From Library Button', - description: 'An implementation of the solution toolbar primary button', - parameters: { - docs: { - page: mdx, - }, - }, -}; - -export const Component = () => { - return ; -}; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx deleted file mode 100644 index 190edc8f29491..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import React from 'react'; -import { ToolbarButton, Props as ToolbarButtonProps } from '../primary/primary'; - -export type Props = Omit; - -const label = { - getLibraryButtonLabel: () => - i18n.translate('sharedUXComponents.toolbar.buttons.addFromLibrary.libraryButtonLabel', { - defaultMessage: 'Add from library', - }), -}; - -export const AddFromLibraryButton = ({ onClick, ...rest }: Props) => ( - -); diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap b/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap deleted file mode 100644 index 8091bd222d1a3..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap +++ /dev/null @@ -1,326 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[` is rendered 1`] = ` - - - -
- - - Legend - - -
- - - - - - - , - , - , - , - ], - }, - } - } - isStringTag={false} - serialized={ - Object { - "map": undefined, - "name": "iuv015-EuiButtonGroup", - "next": undefined, - "styles": "&.euiButtonGroupButton{background-color:#FFF;border:1px solid #D3DAE6 !important;&:first-of-type{border-top-left-radius:6px !important;border-bottom-left-radius:6px !important;}&:last-of-type{border-top-right-radius:6px !important;border-bottom-right-radius:6px !important;}};;label:EuiButtonGroup;", - "toString": [Function], - } - } - /> - - - - - - -
-
- - - -`; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.mdx b/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.mdx deleted file mode 100644 index 979bfb24a0f2f..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: sharedUX/Components/Toolbar/Icon_Button_Group -slug: /shared-ux/components/toolbar/icon_button_group -title: Toolbar Icon Button Group -summary: 'An array of icon-only buttons for use in a toolbar' -tags: ['shared-ux', 'component'] -date: 2022-02-23 ---- - -> This documentation is in-progress. - -This component requires a prop that consists of a series of buttons that can then be displayed based on the number of buttons desired. An example of a button that can be part of an array of icon buttons is included below: - -``` - { - label: 'Text', - onClick: clickHandler, - iconType: 'visText', - } -``` diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.stories.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.stories.tsx deleted file mode 100644 index 988a5bddd513f..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.stories.tsx +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { action } from '@storybook/addon-actions'; -import { Story } from '@storybook/react'; -import React from 'react'; -import { IconButtonGroup } from './icon_button_group'; -import mdx from './icon_button_group.mdx'; - -export default { - title: 'Toolbar/Buttons/Icon Button Group', - description: 'A collection of buttons that is a part of a toolbar.', - parameters: { - docs: { - page: mdx, - }, - }, -}; - -const quickButtons = [ - { - label: 'Text', - onClick: action('onTextClick'), - iconType: 'visText', - title: 'Text as markdown', - }, - { - label: 'Control', - onClick: action('onControlClick'), - iconType: 'controlsHorizontal', - }, - { - label: 'Link', - onClick: action('onLinkClick'), - iconType: 'link', - }, - { - label: 'Image', - onClick: action('onImageClick'), - iconType: 'image', - }, - { - label: 'Markup', - onClick: action('onMarkupClick'), - iconType: 'visVega', - }, -]; - -export const ConnectedComponent: Story<{ buttonCount: number }> = ({ buttonCount }) => { - return ( - - ); -}; - -ConnectedComponent.argTypes = { - buttonCount: { - defaultValue: 2, - control: { - type: 'number', - min: 1, - max: 5, - step: 1, - }, - }, -}; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.test.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.test.tsx deleted file mode 100644 index aefcd59fbd7d5..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.test.tsx +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { mount as enzymeMount, ReactWrapper } from 'enzyme'; -import { - mockServicesFactory, - SharedUxServices, - SharedUxServicesProvider, -} from '@kbn/shared-ux-services'; - -import { IconButtonGroup } from './icon_button_group'; - -describe('', () => { - let services: SharedUxServices; - let mount: (element: JSX.Element) => ReactWrapper; - - beforeEach(() => { - services = mockServicesFactory(); - mount = (element: JSX.Element) => - enzymeMount({element}); - }); - - test('is rendered', () => { - const component = mount( - - ); - - expect(component).toMatchSnapshot(); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/__snapshots__/primary.test.tsx.snap b/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/__snapshots__/primary.test.tsx.snap deleted file mode 100644 index fbe628e30314c..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/__snapshots__/primary.test.tsx.snap +++ /dev/null @@ -1,101 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[` is rendered 1`] = ` - - - - - - - - - -`; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.mdx b/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.mdx deleted file mode 100644 index 5b72eb92360be..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: sharedUX/Components/ToolbarButton -slug: /shared-ux/components/toolbar/buttons/primary -title: Toolbar Button -summary: An opinionated implementation of the toolbar extracted to just the button. -tags: ['shared-ux', 'component'] -date: 2022-03-30 ---- - -> This documentation is in-progress. - -This button is a part of the solution toolbar component. This button has primary styling and requires a label. OnClick handlers, icon side, and icon types are supported as an extension of EuiButtonProps. Icons by default are left of any labels within the button but can also be set to right. diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.stories.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.stories.tsx deleted file mode 100644 index a81be610c1508..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.stories.tsx +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { Story } from '@storybook/react'; -import React from 'react'; -import { ToolbarButton } from './primary'; -import mdx from './primary.mdx'; - -export default { - title: 'Toolbar/Buttons/Primary button', - description: 'A primary button that is a part of a toolbar.', - parameters: { - docs: { - page: mdx, - }, - }, - argTypes: { - iconType: { - control: { - type: 'radio', - expanded: true, - options: ['apps', 'logoGithub', 'folderCheck', 'documents'], - }, - }, - }, -}; - -export const Component: Story<{ - iconType: any; -}> = ({ iconType }) => { - return ; -}; - -Component.args = { - iconType: 'apps', -}; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.test.tsx b/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.test.tsx deleted file mode 100644 index 3e0e153f453e5..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.test.tsx +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { mount as enzymeMount, ReactWrapper } from 'enzyme'; -import React from 'react'; - -import { - SharedUxServicesProvider, - SharedUxServices, - mockServicesFactory, -} from '@kbn/shared-ux-services'; - -import { ToolbarButton } from './primary'; - -describe('', () => { - let services: SharedUxServices; - let mount: (element: JSX.Element) => ReactWrapper; - - beforeEach(() => { - services = mockServicesFactory(); - mount = (element: JSX.Element) => - enzymeMount({element}); - }); - - test('is rendered', () => { - const component = mount(); - - expect(component).toMatchSnapshot(); - }); - test('it can be passed a functional onClick handler', () => { - const mockHandler = jest.fn(); - const component = mount(); - component.simulate('click'); - expect(mockHandler).toHaveBeenCalled(); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/toolbar/index.ts b/packages/kbn-shared-ux-components/src/toolbar/index.ts deleted file mode 100644 index f3e74ace3e5ff..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ -export { ToolbarButton } from './buttons/primary/primary'; -export { IconButtonGroup } from './buttons/icon_button_group/icon_button_group'; -export { AddFromLibraryButton } from './buttons/add_from_library/add_from_library'; -export { ToolbarPopover } from './popovers/popover'; diff --git a/packages/kbn-shared-ux-components/src/toolbar/popovers/__snapshots__/popover.test.tsx.snap b/packages/kbn-shared-ux-components/src/toolbar/popovers/__snapshots__/popover.test.tsx.snap deleted file mode 100644 index c38d0b8e4cd7c..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/popovers/__snapshots__/popover.test.tsx.snap +++ /dev/null @@ -1,89 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[` is rendered 1`] = ` - - - } - closePopover={[Function]} - display="inlineBlock" - hasArrow={true} - isOpen={false} - ownFocus={true} - panelPaddingSize="m" - > -
-
- - - - - - - -
-
- - -`; diff --git a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.stories.tsx b/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.stories.tsx deleted file mode 100644 index f429cebd7071b..0000000000000 --- a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.stories.tsx +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { EuiContextMenu } from '@elastic/eui'; -import { ButtonContentIconSide } from '@elastic/eui/src/components/button/button_content'; -import { Story } from '@storybook/react'; -import React from 'react'; -import { ToolbarPopover } from './popover'; -import mdx from './popover.mdx'; - -export default { - title: 'Toolbar/Popover', - description: 'A popover that is a part of a toolbar.', - parameters: { - docs: { - page: mdx, - }, - }, - argTypes: { - iconSide: { - control: { - type: 'radio', - options: ['left', 'right', 'undefined'], - }, - }, - }, -}; - -export const Component: Story<{ - iconSide: ButtonContentIconSide | undefined; -}> = ({ iconSide }) => { - return ( - - {() => ( - - )} - - ); -}; - -Component.args = { - iconSide: 'left', -}; diff --git a/packages/kbn-shared-ux-storybook/src/config/main.ts b/packages/kbn-shared-ux-storybook/src/config/main.ts index ccd0d1e73cba8..6e57ca8ad5e72 100644 --- a/packages/kbn-shared-ux-storybook/src/config/main.ts +++ b/packages/kbn-shared-ux-storybook/src/config/main.ts @@ -15,4 +15,7 @@ module.exports = { '../../../kbn-shared-ux*/**/*.stories.+(tsx|mdx)', '../../../../src/plugins/shared_ux/**/*.stories.+(tsx|mdx)', ], + reactOptions: { + strictMode: true, + }, }; diff --git a/packages/shared-ux/button_toolbar/BUILD.bazel b/packages/shared-ux/button_toolbar/BUILD.bazel new file mode 100644 index 0000000000000..cbba92916a3a5 --- /dev/null +++ b/packages/shared-ux/button_toolbar/BUILD.bazel @@ -0,0 +1,138 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "button_toolbar" +PKG_REQUIRE_NAME = "@kbn/shared-ux-button-toolbar" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + "src/**/*.scss", + "src/**/*.mdx", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "@npm//@elastic/eui", + "@npm//react", + "//packages/kbn-i18n-react", + "//packages/kbn-i18n", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@elastic/eui", + "@npm//@storybook/addon-actions", + "@npm//@types/jest", + "@npm//@types/node", + "@npm//@types/react", + "//packages/kbn-ambient-ui-types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/kbn-i18n:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, + additional_args = [ + "--copy-files", + "--quiet" + ], +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/shared-ux/button_toolbar/README.mdx b/packages/shared-ux/button_toolbar/README.mdx new file mode 100644 index 0000000000000..fb693dab44498 --- /dev/null +++ b/packages/shared-ux/button_toolbar/README.mdx @@ -0,0 +1,9 @@ +--- +id: sharedUX/ButtonToolbar +slug: /shared-ux/button-toolbar +title: Button Toolbar +summary: +tags: ['shared-ux', 'component'] +date: 2022-06-14 +--- + diff --git a/packages/shared-ux/button_toolbar/jest.config.js b/packages/shared-ux/button_toolbar/jest.config.js new file mode 100644 index 0000000000000..ae826337a4a68 --- /dev/null +++ b/packages/shared-ux/button_toolbar/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../..', + roots: ['/packages/shared-ux/button_toolbar'], +}; diff --git a/packages/shared-ux/button_toolbar/package.json b/packages/shared-ux/button_toolbar/package.json new file mode 100644 index 0000000000000..c9a4569ee2e02 --- /dev/null +++ b/packages/shared-ux/button_toolbar/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/shared-ux-button-toolbar", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} \ No newline at end of file diff --git a/packages/shared-ux/button_toolbar/src/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap new file mode 100644 index 0000000000000..57921977baf2d --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/__snapshots__/add_from_library.test.tsx.snap @@ -0,0 +1,587 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[` is rendered 1`] = ` + + + + + + + + + +`; diff --git a/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.stories.tsx b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.stories.tsx new file mode 100644 index 0000000000000..75872ff2fe2f1 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.stories.tsx @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { AddFromLibraryButton as Component } from './add_from_library'; +import mdx from '../../../README.mdx'; + +export default { + title: 'Button Toolbar/Buttons', + description: 'An implementation of the toolbar primary button', + parameters: { + docs: { + page: mdx, + }, + }, +}; + +export const AddFromLibraryButton = () => { + return ; +}; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.test.tsx b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.test.tsx similarity index 82% rename from packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.test.tsx rename to packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.test.tsx index a2ba1d8bff174..f573f6654e664 100644 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.test.tsx +++ b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.test.tsx @@ -6,14 +6,14 @@ * Side Public License, v 1. */ -import { mount as enzymeMount } from 'enzyme'; import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; + import { AddFromLibraryButton } from './add_from_library'; describe('', () => { test('is rendered', () => { - const component = enzymeMount(); - + const component = mountWithIntl(); expect(component).toMatchSnapshot(); }); }); diff --git a/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx new file mode 100644 index 0000000000000..fd35301d7210d --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; +import React from 'react'; +import { PrimaryButton, Props as ToolbarButtonProps } from '../primary/primary'; + +export type Props = Omit; + +const label = { + getLibraryButtonLabel: () => + i18n.translate('sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel', { + defaultMessage: 'Add from library', + }), +}; + +/** + * A button that acts to add an item from the library to a solution, typically through a modal. + */ +export const AddFromLibraryButton = ({ onClick, ...rest }: Props) => ( + +); diff --git a/packages/shared-ux/button_toolbar/src/buttons/add_from_library/index.ts b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/index.ts new file mode 100644 index 0000000000000..e831d84d237f2 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/add_from_library/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { AddFromLibraryButton } from './add_from_library'; +export type { Props as AddFromLibraryButtonProps } from './add_from_library'; diff --git a/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap new file mode 100644 index 0000000000000..1bf442adb6163 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/__snapshots__/icon_button_group.test.tsx.snap @@ -0,0 +1,384 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[` is rendered 1`] = ` + + +
+ + + Legend + + +
+ + + + + + + , + , + , + , + ], + }, + } + } + isStringTag={false} + serialized={ + Object { + "map": undefined, + "name": "iuv015-EuiButtonGroup", + "next": undefined, + "styles": "&.euiButtonGroupButton{background-color:#FFF;border:1px solid #D3DAE6 !important;&:first-of-type{border-top-left-radius:6px !important;border-bottom-left-radius:6px !important;}&:last-of-type{border-top-right-radius:6px !important;border-bottom-right-radius:6px !important;}};;label:EuiButtonGroup;", + "toString": [Function], + } + } + /> + + + + + + +
+
+ + +`; diff --git a/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.stories.tsx b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.stories.tsx new file mode 100644 index 0000000000000..21fff3f3ed887 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.stories.tsx @@ -0,0 +1,71 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { action } from '@storybook/addon-actions'; +import React from 'react'; +import { IconButtonGroup as Component } from './icon_button_group'; +import mdx from '../../../README.mdx'; + +export default { + title: 'Button Toolbar/Buttons', + description: 'A collection of icon buttons that is a part of a toolbar.', + parameters: { + docs: { + page: mdx, + }, + }, +}; + +const quickButtons = [ + { + label: 'Text', + onClick: action('onTextClick'), + iconType: 'visText', + title: 'Text as markdown', + }, + { + label: 'Control', + onClick: action('onControlClick'), + iconType: 'controlsHorizontal', + }, + { + label: 'Link', + onClick: action('onLinkClick'), + iconType: 'link', + }, + { + label: 'Image', + onClick: action('onImageClick'), + iconType: 'image', + }, + { + label: 'Markup', + onClick: action('onMarkupClick'), + iconType: 'visVega', + }, +]; + +const argTypes = { + buttonCount: { + defaultValue: 2, + control: { + type: 'number', + min: 1, + max: 5, + step: 1, + }, + }, +}; + +type Params = Record; + +export const IconButtonGroup = ({ buttonCount }: Params) => { + return ; +}; + +IconButtonGroup.argTypes = argTypes; diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.styles.ts b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.styles.ts similarity index 100% rename from packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.styles.ts rename to packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.styles.ts diff --git a/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.test.tsx b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.test.tsx new file mode 100644 index 0000000000000..db5722986bcc0 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.test.tsx @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; + +import { IconButtonGroup } from './icon_button_group'; + +describe('', () => { + test('is rendered', () => { + const component = mountWithIntl( + + ); + + expect(component).toMatchSnapshot(); + }); +}); diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx similarity index 78% rename from packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx rename to packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx index 3ac5f87622d99..cc8ff6316157b 100644 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx +++ b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx @@ -15,36 +15,38 @@ import { IconType, EuiButtonGroupProps, } from '@elastic/eui'; + import { IconButtonGroupStyles } from './icon_button_group.styles'; + +/** + * An interface representing a single icon button in the `IconButtonGroup`. + */ export interface IconButton { - /** - * The accessible button label - */ + /** The accessible button label. */ label: string; - /** - * EUI `IconType` to display - */ + /** EUI `IconType` to display. */ iconType: IconType; + /** Handler for button click. */ onClick: () => void; - /** - * HTML `title` attribute for tooltips if different from `label` - */ + /** HTML `title` attribute for tooltips if different from `label` */ title?: string; } +/** + * Props for `IconButtonGroup`. + */ export interface Props { - /** - * Required accessible legend for the whole group - */ + /** Required accessible legend for the whole group */ legend: EuiButtonGroupProps['legend']; - /** - * Array of `QuickButton`s - */ + /** Array of `IconButton` */ buttons: IconButton[]; } type Option = EuiButtonGroupOptionProps & Omit; +/** + * A group of buttons each performing an action, represented by an icon. + */ export const IconButtonGroup = ({ buttons, legend }: Props) => { const euiTheme = useEuiTheme(); const iconButtonGroupStyles = IconButtonGroupStyles(euiTheme); diff --git a/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/index.ts b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/index.ts new file mode 100644 index 0000000000000..35dfe250cd054 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/icon_button_group/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { IconButtonGroup } from './icon_button_group'; +export type { IconButton, Props as IconButtonGroupProps } from './icon_button_group'; diff --git a/packages/shared-ux/button_toolbar/src/buttons/index.ts b/packages/shared-ux/button_toolbar/src/buttons/index.ts new file mode 100644 index 0000000000000..c747130c769c7 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/index.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { PrimaryButton } from './primary'; +export type { PrimaryButtonProps } from './primary'; + +export { IconButtonGroup } from './icon_button_group'; +export type { IconButtonGroupProps, IconButton } from './icon_button_group'; + +export { AddFromLibraryButton } from './add_from_library'; +export type { AddFromLibraryButtonProps } from './add_from_library'; diff --git a/packages/shared-ux/button_toolbar/src/buttons/primary/__snapshots__/primary.test.tsx.snap b/packages/shared-ux/button_toolbar/src/buttons/primary/__snapshots__/primary.test.tsx.snap new file mode 100644 index 0000000000000..dfd75c6ff000e --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/primary/__snapshots__/primary.test.tsx.snap @@ -0,0 +1,465 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[` is rendered 1`] = ` + + + + + + + +`; diff --git a/packages/shared-ux/button_toolbar/src/buttons/primary/index.ts b/packages/shared-ux/button_toolbar/src/buttons/primary/index.ts new file mode 100644 index 0000000000000..1d3220b3654aa --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/primary/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { PrimaryButton } from './primary'; +export type { Props as PrimaryButtonProps } from './primary'; diff --git a/packages/shared-ux/button_toolbar/src/buttons/primary/primary.stories.tsx b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.stories.tsx new file mode 100644 index 0000000000000..fb3b53b160f4c --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.stories.tsx @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; + +import { PrimaryButton as Component } from './primary'; +import mdx from '../../../README.mdx'; + +const argTypes = { + iconType: { + control: { + type: 'radio', + expanded: true, + options: ['apps', 'logoGithub', 'folderCheck', 'documents'], + }, + }, +}; + +type Params = Record; + +export default { + title: 'Button Toolbar/Buttons', + description: 'A primary button that is a part of a toolbar.', + parameters: { + docs: { + page: mdx, + }, + }, + argTypes, +}; + +export const PrimaryButton = ({ iconType }: Params) => { + return ; +}; + +PrimaryButton.args = { + iconType: 'apps', +}; diff --git a/packages/shared-ux/button_toolbar/src/buttons/primary/primary.test.tsx b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.test.tsx new file mode 100644 index 0000000000000..10cbe7cb4dff0 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.test.tsx @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; + +import { PrimaryButton } from './primary'; + +describe('', () => { + test('is rendered', () => { + const component = mountWithIntl(); + expect(component).toMatchSnapshot(); + }); + + test('it can be passed a functional onClick handler', () => { + const mockHandler = jest.fn(); + const component = mountWithIntl(); + component.simulate('click'); + expect(mockHandler).toHaveBeenCalled(); + }); +}); diff --git a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx similarity index 81% rename from packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx rename to packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx index f935a08fe8434..4d2975db2682b 100644 --- a/packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx +++ b/packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx @@ -10,11 +10,17 @@ import React from 'react'; import { EuiButton } from '@elastic/eui'; import { EuiButtonPropsForButton } from '@elastic/eui/src/components/button/button'; +/** + * Props for `PrimaryButton`. + */ export interface Props extends Pick { label: string; } -export const ToolbarButton = ({ label, iconSide = 'left', ...rest }: Props) => { +/** + * A primary action button, usually appearing first in the toolbar. + */ +export const PrimaryButton = ({ label, iconSide = 'left', ...rest }: Props) => { return ( {label} diff --git a/packages/shared-ux/button_toolbar/src/index.ts b/packages/shared-ux/button_toolbar/src/index.ts new file mode 100644 index 0000000000000..6ee6230881039 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { PrimaryButton, IconButtonGroup, AddFromLibraryButton } from './buttons'; +export type { + AddFromLibraryButtonProps, + IconButtonGroupProps, + IconButton, + PrimaryButtonProps, +} from './buttons'; + +export { ToolbarPopover } from './popover'; +export type { ToolbarPopoverProps } from './popover'; diff --git a/packages/shared-ux/button_toolbar/src/popover/__snapshots__/popover.test.tsx.snap b/packages/shared-ux/button_toolbar/src/popover/__snapshots__/popover.test.tsx.snap new file mode 100644 index 0000000000000..d727134b4dcdd --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/popover/__snapshots__/popover.test.tsx.snap @@ -0,0 +1,395 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[` is rendered 1`] = ` + + + } + closePopover={[Function]} + display="inlineBlock" + hasArrow={true} + intl={ + Object { + "defaultFormats": Object {}, + "defaultLocale": "en", + "formatDate": [Function], + "formatHTMLMessage": [Function], + "formatMessage": [Function], + "formatNumber": [Function], + "formatPlural": [Function], + "formatRelative": [Function], + "formatTime": [Function], + "formats": Object { + "date": Object { + "full": Object { + "day": "numeric", + "month": "long", + "weekday": "long", + "year": "numeric", + }, + "long": Object { + "day": "numeric", + "month": "long", + "year": "numeric", + }, + "medium": Object { + "day": "numeric", + "month": "short", + "year": "numeric", + }, + "short": Object { + "day": "numeric", + "month": "numeric", + "year": "2-digit", + }, + }, + "number": Object { + "currency": Object { + "style": "currency", + }, + "percent": Object { + "style": "percent", + }, + }, + "relative": Object { + "days": Object { + "units": "day", + }, + "hours": Object { + "units": "hour", + }, + "minutes": Object { + "units": "minute", + }, + "months": Object { + "units": "month", + }, + "seconds": Object { + "units": "second", + }, + "years": Object { + "units": "year", + }, + }, + "time": Object { + "full": Object { + "hour": "numeric", + "minute": "numeric", + "second": "numeric", + "timeZoneName": "short", + }, + "long": Object { + "hour": "numeric", + "minute": "numeric", + "second": "numeric", + "timeZoneName": "short", + }, + "medium": Object { + "hour": "numeric", + "minute": "numeric", + "second": "numeric", + }, + "short": Object { + "hour": "numeric", + "minute": "numeric", + }, + }, + }, + "formatters": Object { + "getDateTimeFormat": [Function], + "getMessageFormat": [Function], + "getNumberFormat": [Function], + "getPluralFormat": [Function], + "getRelativeFormat": [Function], + }, + "locale": "en", + "messages": Object {}, + "now": [Function], + "onError": [Function], + "textComponent": Symbol(react.fragment), + "timeZone": null, + } + } + isOpen={false} + ownFocus={true} + panelPaddingSize="m" + > +
+
+ + + + + + + +
+
+ + +`; diff --git a/packages/shared-ux/button_toolbar/src/popover/index.ts b/packages/shared-ux/button_toolbar/src/popover/index.ts new file mode 100644 index 0000000000000..10167b975f584 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/popover/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { ToolbarPopover } from './popover'; +export type { Props as ToolbarPopoverProps } from './popover'; diff --git a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.mdx b/packages/shared-ux/button_toolbar/src/popover/popover.mdx similarity index 100% rename from packages/kbn-shared-ux-components/src/toolbar/popovers/popover.mdx rename to packages/shared-ux/button_toolbar/src/popover/popover.mdx diff --git a/packages/shared-ux/button_toolbar/src/popover/popover.stories.tsx b/packages/shared-ux/button_toolbar/src/popover/popover.stories.tsx new file mode 100644 index 0000000000000..e0c37b035cbd9 --- /dev/null +++ b/packages/shared-ux/button_toolbar/src/popover/popover.stories.tsx @@ -0,0 +1,77 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; + +import { EuiContextMenu } from '@elastic/eui'; + +import { ToolbarPopover as Component } from './popover'; +import mdx from '../../README.mdx'; + +const argTypes = { + iconSide: { + control: { + type: 'radio', + options: ['left', 'right', 'undefined'], + }, + }, +}; + +type Params = Record; + +export default { + title: 'Button Toolbar', + description: 'A popover that is a part of a toolbar.', + parameters: { + docs: { + page: mdx, + }, + }, + argTypes, +}; + +export const Popover = ({ iconSide }: Params) => { + return ( + + {() => ( + + )} + + ); +}; + +Popover.args = { + iconSide: 'left', +}; diff --git a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.test.tsx b/packages/shared-ux/button_toolbar/src/popover/popover.test.tsx similarity index 81% rename from packages/kbn-shared-ux-components/src/toolbar/popovers/popover.test.tsx rename to packages/shared-ux/button_toolbar/src/popover/popover.test.tsx index fcbf3d3542a16..022ab3fe56f51 100644 --- a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.test.tsx +++ b/packages/shared-ux/button_toolbar/src/popover/popover.test.tsx @@ -6,14 +6,15 @@ * Side Public License, v 1. */ -import { mount as enzymeMount } from 'enzyme'; import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; + import { ToolbarPopover } from './popover'; describe('', () => { test('is rendered', () => { const isOpen = true; - const component = enzymeMount( !isOpen} />); + const component = mountWithIntl( !isOpen} />); expect(component).toMatchSnapshot(); }); @@ -21,9 +22,11 @@ describe('', () => { test('accepts an onClick handler', () => { const isOpen = true; const mockHandler = jest.fn(); - const component = enzymeMount( + + const component = mountWithIntl( !isOpen} onClick={mockHandler} /> ); + component.simulate('click'); expect(mockHandler).toHaveBeenCalled(); }); diff --git a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx b/packages/shared-ux/button_toolbar/src/popover/popover.tsx similarity index 86% rename from packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx rename to packages/shared-ux/button_toolbar/src/popover/popover.tsx index ceae588b61941..fdf60c1f0d5fa 100644 --- a/packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx +++ b/packages/shared-ux/button_toolbar/src/popover/popover.tsx @@ -10,7 +10,7 @@ import React, { useState } from 'react'; import { EuiPopover } from '@elastic/eui'; import { Props as EuiPopoverProps } from '@elastic/eui/src/components/popover/popover'; -import { ToolbarButton, Props as ButtonProps } from '../buttons/primary/primary'; +import { PrimaryButton, Props as ButtonProps } from '../buttons/primary/primary'; type AllowedButtonProps = Omit; type AllowedPopoverProps = Omit< @@ -18,18 +18,24 @@ type AllowedPopoverProps = Omit< 'button' | 'isOpen' | 'closePopover' | 'anchorPosition' >; +/** + * Props for `ToolbarPopover`. + */ export type Props = AllowedButtonProps & AllowedPopoverProps & { children: (arg: { closePopover: () => void }) => React.ReactNode; }; +/** + * A button which opens a popover of additional actions within the toolbar. + */ export const ToolbarPopover = ({ label, iconType, children, iconSide, ...popover }: Props) => { const [isOpen, setIsOpen] = useState(false); const onButtonClick = () => setIsOpen((status) => !status); const closePopover = () => setIsOpen(false); - const button = ; + const button = ; return ( // the following ts-ignore is needed until typings/* directory is exposed for consumption to packages diff --git a/packages/shared-ux/button_toolbar/tsconfig.json b/packages/shared-ux/button_toolbar/tsconfig.json new file mode 100644 index 0000000000000..384042fcd7bd4 --- /dev/null +++ b/packages/shared-ux/button_toolbar/tsconfig.json @@ -0,0 +1,19 @@ +{ + "extends": "../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node", + "react", + "@kbn/ambient-ui-types" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/shared-ux/card/no_data/BUILD.bazel b/packages/shared-ux/card/no_data/BUILD.bazel new file mode 100644 index 0000000000000..ae3e21ba55247 --- /dev/null +++ b/packages/shared-ux/card/no_data/BUILD.bazel @@ -0,0 +1,143 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "no_data" +PKG_REQUIRE_NAME = "@kbn/shared-ux-card-no-data" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + "src/**/*.mdx", + "src/**/*.svg", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "@npm//@elastic/eui", + "@npm//@storybook/addon-actions", + "@npm//enzyme", + "@npm//react", + "//packages/kbn-i18n-react", + "//packages/kbn-i18n", + "//packages/shared-ux/link/redirect_app", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@elastic/eui", + "@npm//@storybook/addon-actions", + "@npm//@types/enzyme", + "@npm//@types/jest", + "@npm//@types/node", + "@npm//@types/react", + "//packages/kbn-ambient-ui-types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/kbn-i18n:npm_module_types", + "//packages/shared-ux/link/redirect_app:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, + additional_args = [ + "--copy-files", + "--quiet" + ], +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/shared-ux/card/no_data/README.mdx b/packages/shared-ux/card/no_data/README.mdx new file mode 100644 index 0000000000000..e2b044c27ac44 --- /dev/null +++ b/packages/shared-ux/card/no_data/README.mdx @@ -0,0 +1,29 @@ +--- +id: sharedUX/Components/NoDataCard +slug: /shared-ux/components/no-data-card +title: No Data Card +summary: A card displayed when no data is available is available in Kibana. +tags: ['shared-ux', 'component'] +date: 2022-06-15 +--- + +## Description + +A wrapper around `EuiCard` tailored for use in Kibana solutions when no data is available. + +## Usage + +All of the `EuiCard` props are available with the exception of `layout`. A default `description` and `button` are provided, but can be overridden in specific use cases. + +The `NoDataCard` connected component uses: + +- `navLinks.integrations` from `coreStart.application.capabilities` to determine if the user has access to the Integrations page. +- `addBasePath` from `coreStart` to navigate to the Integrations page. + +## API +| Export | Description | +|---|---| +| `NoDataCardProvider` | Provides contextual services to `NoDataCard`. | +| `NoDataCardKibanaProvider` | Maps Kibana dependencies to provide contextual services to `NoDataCard`. | +| `NoDataCard` | Uses a `Provider` to access contextual services to populate props on the `NoDataCardComponent`. | +| `NoDataCardComponent` | The pure component, a pre-configured **EuiCard**. | \ No newline at end of file diff --git a/packages/shared-ux/card/no_data/jest.config.js b/packages/shared-ux/card/no_data/jest.config.js new file mode 100644 index 0000000000000..47ce28115535f --- /dev/null +++ b/packages/shared-ux/card/no_data/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/shared-ux/card/no_data'], +}; diff --git a/packages/shared-ux/card/no_data/package.json b/packages/shared-ux/card/no_data/package.json new file mode 100644 index 0000000000000..a1d3efd5a6985 --- /dev/null +++ b/packages/shared-ux/card/no_data/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/shared-ux-card-no-data", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap new file mode 100644 index 0000000000000..17eb4ef8804cd --- /dev/null +++ b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap @@ -0,0 +1,117 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`NoDataCardComponent props button 1`] = ` + + Button + + } + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent props href 1`] = ` + + Add Elastic Agent + + } + href="some path" + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent renders 1`] = ` + + Add Elastic Agent + + } + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent renders with canAccessFleet false 1`] = ` + + This integration is not yet enabled. Your administrator has the required permissions to turn it on. + + } + image={} + isDisabled={true} + paddingSize="l" + title={ + + Contact your administrator + + } +/> +`; diff --git a/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap new file mode 100644 index 0000000000000..1f4277ffd139f --- /dev/null +++ b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap @@ -0,0 +1,356 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`NoDataCard props button 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props extends EuiCardProps 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props href 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props no access to Fleet 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + +
+

+ + This integration is not yet enabled. Your administrator has the required permissions to turn it on. + +

+
+
+
+
+`; + +exports[`NoDataCard renders 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/assets/elastic_agent_card.svg b/packages/shared-ux/card/no_data/src/assets/elastic_agent_card.svg similarity index 100% rename from packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/assets/elastic_agent_card.svg rename to packages/shared-ux/card/no_data/src/assets/elastic_agent_card.svg diff --git a/packages/shared-ux/card/no_data/src/index.ts b/packages/shared-ux/card/no_data/src/index.ts new file mode 100644 index 0000000000000..24463007b5a8c --- /dev/null +++ b/packages/shared-ux/card/no_data/src/index.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { NoDataCard } from './no_data_card'; +export type { Props as NoDataCardProps } from './no_data_card'; + +export { NoDataCardKibanaProvider, NoDataCardProvider } from './services'; +export type { NoDataCardKibanaDependencies, NoDataCardServices } from './services'; + +export { + getMockServices as getNoDataCardMockServices, + getStoryArgTypes as getNoDataCardStoryArgTypes, + getStoryServices as getNoDataCardStoryServices, +} from './mocks'; diff --git a/packages/shared-ux/card/no_data/src/mocks.ts b/packages/shared-ux/card/no_data/src/mocks.ts new file mode 100644 index 0000000000000..d5ec849e1456b --- /dev/null +++ b/packages/shared-ux/card/no_data/src/mocks.ts @@ -0,0 +1,88 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { action } from '@storybook/addon-actions'; +import { + getRedirectAppLinksMockServices, + getRedirectAppLinksStoryArgTypes, + getRedirectAppLinksStoryServices, +} from '@kbn/shared-ux-link-redirect-app'; + +import { NoDataCardServices } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; + +/** + * Returns Storybook-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getStoryServices = (params: Params) => { + const services: NoDataCardServices = { + ...getRedirectAppLinksStoryServices(), + ...params, + addBasePath: (path) => { + action('addBasePath')(path); + return path; + }, + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `NoDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({ + ...getRedirectAppLinksStoryArgTypes(), + canAccessFleet: { + control: 'boolean', + defaultValue: true, + }, + category: { + control: { + type: 'text', + }, + defaultValue: '', + }, + title: { + control: { + type: 'text', + }, + defaultValue: '', + }, + description: { + control: { + type: 'text', + }, + defaultValue: '', + }, + button: { + control: { + type: 'text', + }, + defaultValue: '', + }, +}); + +/** + * Returns the Jest-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getMockServices = (params?: Params) => { + const { canAccessFleet } = params || { canAccessFleet: true }; + + const services: NoDataCardServices = { + ...getRedirectAppLinksMockServices(), + canAccessFleet, + addBasePath: (path) => path, + }; + + return services; +}; diff --git a/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx b/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx new file mode 100644 index 0000000000000..72d179602e6d5 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { shallow } from 'enzyme'; + +import { NoDataCard } from './no_data_card.component'; + +describe('NoDataCardComponent', () => { + test('renders', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + test('renders with canAccessFleet false', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + describe('props', () => { + test('button', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + test('href', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + }); +}); diff --git a/packages/shared-ux/card/no_data/src/no_data_card.component.tsx b/packages/shared-ux/card/no_data/src/no_data_card.component.tsx new file mode 100644 index 0000000000000..43c4e9cd3a4af --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.component.tsx @@ -0,0 +1,136 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { MouseEventHandler, ReactNode } from 'react'; +import { + EuiButton, + EuiCard, + EuiScreenReaderOnly, + EuiTextColor, + EuiCardProps, + EuiImage, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { NoDataCardStyles } from './no_data_card.styles'; +import ElasticAgentCardIllustration from './assets/elastic_agent_card.svg'; + +export type Props = Partial< + Omit +> & { + /** + * Provide just a string for the button's label, or a whole component; + * The button will be hidden completely if `isDisabled=true` + */ + button?: string | ReactNode; + /** Remapping `onClick` to any element */ + onClick?: MouseEventHandler; + /** + * Description for the card; + * If not provided, the default will be used + */ + description?: string | ReactNode; + /** Category to auto-select within Fleet */ + category?: string; + /** True if the person has permission to access Fleet, false otherwise */ + canAccessFleet?: boolean; +}; + +const noPermissionTitle = i18n.translate('sharedUXPackages.card.noData.noPermission.title', { + defaultMessage: `Contact your administrator`, +}); + +const noPermissionDescription = i18n.translate( + 'sharedUXPackages.card.noData.noPermission.description', + { + defaultMessage: `This integration is not yet enabled. Your administrator has the required permissions to turn it on.`, + } +); + +const defaultTitle = i18n.translate('sharedUXPackages.card.noData.title', { + defaultMessage: 'Add Elastic Agent', +}); + +const defaultDescription = i18n.translate('sharedUXPackages.card.noData.description', { + defaultMessage: `Use Elastic Agent for a simple, unified way to collect data from your machines.`, +}); + +const Image = () => ( + +); + +/** + * Creates a specific NoDataCard pointing users to Integrations when `canAccessFleet` + */ +export const NoDataCard = ({ + title: titleProp, + description: descriptionProp, + canAccessFleet, + button, + ...props +}: Props) => { + const styles = NoDataCardStyles(); + + const footer = () => { + // Don't render the footer action if disabled + if (!canAccessFleet) { + return; + } + + // Render a custom footer action if the button is not a simple string + if (button && typeof button !== 'string') { + return button; + } + + // Default footer action is a button with the provided or default string + return {button || titleProp || defaultTitle}; + }; + + const title = () => { + if (!canAccessFleet) { + return {noPermissionTitle}; + } + + return ( + + {titleProp || defaultTitle} + + ); + }; + + const description = () => { + if (!canAccessFleet) { + return {noPermissionDescription}; + } + + return descriptionProp || defaultDescription; + }; + + return ( + } + {...props} + /> + ); +}; diff --git a/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx b/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx new file mode 100644 index 0000000000000..38f299d3d3d35 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; + +import { Params, getStoryArgTypes, getStoryServices } from './mocks'; + +import { NoDataCard as Component } from './no_data_card.component'; +import { NoDataCard as ConnectedComponent } from './no_data_card'; +import { NoDataCardProvider } from './services'; + +import mdx from '../README.mdx'; + +export default { + title: 'No Data/Card', + description: 'A solution-specific wrapper around `EuiCard`, to be used on `NoData` page', + parameters: { + docs: { + page: mdx, + }, + }, +}; + +const argTypes = getStoryArgTypes(); + +export const NoDataCard = (params: Params) => { + return ( + + + + ); +}; + +NoDataCard.argTypes = argTypes; + +export const NoDataCardComponent = (params: Params) => { + return ; +}; + +NoDataCardComponent.argTypes = argTypes; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.styles.ts b/packages/shared-ux/card/no_data/src/no_data_card.styles.ts similarity index 100% rename from packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.styles.ts rename to packages/shared-ux/card/no_data/src/no_data_card.styles.ts diff --git a/packages/shared-ux/card/no_data/src/no_data_card.test.tsx b/packages/shared-ux/card/no_data/src/no_data_card.test.tsx new file mode 100644 index 0000000000000..0f659ad7a7f50 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.test.tsx @@ -0,0 +1,66 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { render as enzymeRender } from 'enzyme'; +import React from 'react'; + +import { NoDataCard } from './no_data_card'; +import { NoDataCardProvider } from './services'; + +const services = { + addBasePath: (path: string) => path, + navigateToUrl: () => {}, +}; + +describe('NoDataCard', () => { + const render = (element: React.ReactElement, canAccessFleet: boolean = true) => + enzymeRender( + {element} + ); + + test('renders', () => { + const component = render(); + expect(component).toMatchSnapshot(); + }); + + describe('props', () => { + test('button', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + + test('href', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + + test('no access to Fleet', () => { + const component = render( + , + false + ); + expect(component).toMatchSnapshot(); + }); + + test('extends EuiCardProps', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + }); +}); diff --git a/packages/shared-ux/card/no_data/src/no_data_card.tsx b/packages/shared-ux/card/no_data/src/no_data_card.tsx new file mode 100644 index 0000000000000..a58ee5bc9d08b --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.tsx @@ -0,0 +1,41 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { useMemo } from 'react'; +import { RedirectAppLinksContainer } from '@kbn/shared-ux-link-redirect-app'; + +import { NoDataCard as Component, Props as ComponentProps } from './no_data_card.component'; + +import { useServices } from './services'; + +export type Props = Omit; + +export const NoDataCard = ({ href: srcHref, category, description, ...props }: Props) => { + const { canAccessFleet, addBasePath } = useServices(); + + const href = useMemo(() => { + if (srcHref) { + return srcHref; + } + + // TODO: get this URL from a locator + const prefix = '/app/integrations/browse'; + + if (category) { + return addBasePath(`${prefix}/${category}`); + } + + return addBasePath(prefix); + }, [addBasePath, srcHref, category]); + + return ( + + + + ); +}; diff --git a/packages/shared-ux/card/no_data/src/services.tsx b/packages/shared-ux/card/no_data/src/services.tsx new file mode 100644 index 0000000000000..c4937a6d21da9 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/services.tsx @@ -0,0 +1,97 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { FC, useContext } from 'react'; +import { + RedirectAppLinksServices, + RedirectAppLinksKibanaDependencies, + RedirectAppLinksProvider, + RedirectAppLinksKibanaProvider, +} from '@kbn/shared-ux-link-redirect-app'; + +/** + * A list of services that are consumed by this component. + */ +interface Services { + addBasePath: (path: string) => string; + canAccessFleet: boolean; +} + +const Context = React.createContext(null); + +/** + * Services that are consumed by this component and its dependencies. + */ +export type NoDataCardServices = Services & RedirectAppLinksServices; + +/** + * A Context Provider that provides services to the component and its dependencies. + */ +export const NoDataCardProvider: FC = ({ children, ...services }) => { + const { addBasePath, canAccessFleet } = services; + + return ( + + {children} + + ); +}; + +interface KibanaDependencies { + coreStart: { + http: { + basePath: { + prepend: (path: string) => string; + }; + }; + application: { + capabilities: { + navLinks: Record; + }; + }; + }; +} +/** + * An interface containing a collection of Kibana plugins and services required to + * render this component as well as its dependencies. + */ +export type NoDataCardKibanaDependencies = KibanaDependencies & RedirectAppLinksKibanaDependencies; + +/** + * Kibana-specific Provider that maps dependencies to services. + */ +export const NoDataCardKibanaProvider: FC = ({ + children, + ...dependencies +}) => { + const value: Services = { + addBasePath: dependencies.coreStart.http.basePath.prepend, + canAccessFleet: dependencies.coreStart.application.capabilities.navLinks.integrations, + }; + + return ( + + {children} + + ); +}; + +/** + * React hook for accessing pre-wired services. + */ +export function useServices() { + const context = useContext(Context); + + if (!context) { + throw new Error( + 'NoDataCard Context is missing. Ensure your component or React root is wrapped with NoDataCardContext.' + ); + } + + return context; +} diff --git a/packages/shared-ux/card/no_data/tsconfig.json b/packages/shared-ux/card/no_data/tsconfig.json new file mode 100644 index 0000000000000..44b240540718d --- /dev/null +++ b/packages/shared-ux/card/no_data/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node", + "react", + "@emotion/react/types/css-prop", + "@kbn/ambient-ui-types" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/shared-ux/link/redirect_app/src/index.tsx b/packages/shared-ux/link/redirect_app/src/index.tsx index 09317ebab59f7..0d1c61242edb3 100644 --- a/packages/shared-ux/link/redirect_app/src/index.tsx +++ b/packages/shared-ux/link/redirect_app/src/index.tsx @@ -10,16 +10,27 @@ export { RedirectAppLinks as RedirectAppLinksContainer } from './redirect_app_li export { RedirectAppLinks as RedirectAppLinksComponent } from './redirect_app_links.component'; export { RedirectAppLinksKibanaProvider, RedirectAppLinksProvider } from './services'; +export type { + Services as RedirectAppLinksServices, + KibanaDependencies as RedirectAppLinksKibanaDependencies, +} from './services'; + +export { + getMockServices as getRedirectAppLinksMockServices, + getStoryArgTypes as getRedirectAppLinksStoryArgTypes, + getStoryServices as getRedirectAppLinksStoryServices, +} from './mocks'; + import React, { FC } from 'react'; import { RedirectAppLinks as RedirectAppLinksContainer } from './redirect_app_links'; import { Services, - KibanaServices, + KibanaDependencies, RedirectAppLinksKibanaProvider, RedirectAppLinksProvider, } from './services'; -const isKibanaContract = (services: any): services is KibanaServices => { +const isKibanaContract = (services: any): services is KibanaDependencies => { return typeof services.coreStart !== 'undefined'; }; @@ -28,12 +39,22 @@ const isKibanaContract = (services: any): services is KibanaServices => { * `RedirectAppLinksKibanaProvider` based on the services provided, creating a single component * with which consumers can wrap their components or solutions. */ -export const RedirectAppLinks: FC = ({ children, ...services }) => { +export const RedirectAppLinks: FC = ({ children, ...services }) => { const container = {children}; - return isKibanaContract(services) ? ( - {container} - ) : ( - {container} + if (isKibanaContract(services)) { + const { coreStart } = services; + return ( + + {container} + + ); + } + + const { navigateToUrl, currentAppId } = services; + return ( + + {container} + ); }; diff --git a/packages/shared-ux/link/redirect_app/src/mocks.ts b/packages/shared-ux/link/redirect_app/src/mocks.ts new file mode 100644 index 0000000000000..4b5519dd646bb --- /dev/null +++ b/packages/shared-ux/link/redirect_app/src/mocks.ts @@ -0,0 +1,46 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { action } from '@storybook/addon-actions'; + +import { Services } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; + +/** + * Returns Storybook-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getStoryServices = () => { + const services: Services = { + navigateToUrl: action('navigateToUrl'), + currentAppId: 'currentAppId', + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `NoDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({}); + +/** + * Returns the Jest-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getMockServices = () => { + const services: Services = { + navigateToUrl: jest.fn(), + currentAppId: 'currentAppId', + }; + + return services; +}; diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx index 477471fe71824..f0da5b307fbd1 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx @@ -29,12 +29,7 @@ export interface Props extends DetailedHTMLProps, * * ``` */ -export const RedirectAppLinks: FC = ({ - children, - navigateToUrl, - currentAppId, - ...otherProps -}) => { +export const RedirectAppLinks: FC = ({ children, navigateToUrl, currentAppId }) => { const containerRef = useRef(null); const handleClick: MouseEventHandler = useCallback( @@ -50,7 +45,7 @@ export const RedirectAppLinks: FC = ({ return ( // eslint-disable-next-line jsx-a11y/click-events-have-key-events -
+
{children}
); diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx index 9bb3d0d9782d4..1b77f7148964e 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx @@ -10,11 +10,12 @@ import { EuiButton, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import React from 'react'; import { action } from '@storybook/addon-actions'; -import { RedirectAppLinks } from '.'; +import { RedirectAppLinks as Component } from '.'; +import { getStoryArgTypes, getStoryServices } from './mocks'; import mdx from '../README.mdx'; export default { - title: 'Redirect App Links', + title: 'Link', description: 'An "area of effect" component which intercepts clicks on anchor elements and redirects them to Kibana solutions without a page refresh.', parameters: { @@ -24,16 +25,10 @@ export default { }, }; -export const Component = () => { - const navigateToUrl = async (url: string) => { - action('navigateToUrl')(url); - }; - - const currentAppId = 'abc123'; - +export const RedirectAppLinks = () => { return ( <> - + { - + { ); }; + +RedirectAppLinks.argTypes = getStoryArgTypes(); diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx index 1e805ad4475b6..9a069881b2128 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx @@ -6,15 +6,10 @@ * Side Public License, v 1. */ -import React from 'react'; +import React, { FC } from 'react'; import { useServices } from './services'; -import { - RedirectAppLinks as Component, - Props as ComponentProps, -} from './redirect_app_links.component'; - -type Props = Omit; +import { RedirectAppLinks as Component } from './redirect_app_links.component'; /** * A service-enabled component that provides Kibana-specific functionality to the `RedirectAppLinks` @@ -27,4 +22,6 @@ type Props = Omit; * * ``` */ -export const RedirectAppLinks = (props: Props) => ; +export const RedirectAppLinks: FC<{}> = ({ children }) => ( + {children} +); diff --git a/packages/shared-ux/link/redirect_app/src/services.tsx b/packages/shared-ux/link/redirect_app/src/services.tsx index 22bc5a5cd0c55..b29d82f8eea13 100644 --- a/packages/shared-ux/link/redirect_app/src/services.tsx +++ b/packages/shared-ux/link/redirect_app/src/services.tsx @@ -25,8 +25,9 @@ const RedirectAppLinksContext = React.createContext(null); * Contextual services Provider. */ export const RedirectAppLinksProvider: FC = ({ children, ...services }) => { + const { navigateToUrl, currentAppId } = services; return ( - + {children} ); @@ -35,7 +36,7 @@ export const RedirectAppLinksProvider: FC = ({ children, ...services } /** * Kibana-specific contextual services to be adapted for this component. */ -export interface KibanaServices { +export interface KibanaDependencies { coreStart: { application: { currentAppId$: Observable; @@ -47,7 +48,7 @@ export interface KibanaServices { /** * Kibana-specific contextual services Provider. */ -export const RedirectAppLinksKibanaProvider: FC = ({ children, coreStart }) => { +export const RedirectAppLinksKibanaProvider: FC = ({ children, coreStart }) => { const { navigateToUrl, currentAppId$ } = coreStart.application; const currentAppId = useObservable(currentAppId$, undefined); diff --git a/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx b/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx index d5d82d801fc8d..8cb9b3aaa5f7e 100644 --- a/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx +++ b/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx @@ -16,7 +16,7 @@ import mdx from '../README.mdx'; import { Params, getStoryArgTypes, getStoryServices } from './mocks'; export default { - title: 'No Data/Analytics', + title: 'No Data/Analytics Page', description: 'An Analytics-specific version of KibanaNoDataPage.', parameters: { docs: { diff --git a/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx b/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx index 206b958e64771..c18adc20e4af0 100644 --- a/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx +++ b/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx @@ -16,7 +16,7 @@ import { KibanaNoDataPageProvider } from './services'; import mdx from '../README.mdx'; export default { - title: 'No Data/Kibana', + title: 'No Data/Kibana Page', description: 'A component to display when there is no data available', parameters: { docs: { diff --git a/packages/shared-ux/page/kibana_no_data/src/mocks.ts b/packages/shared-ux/page/kibana_no_data/src/mocks.ts index e88097c933849..d91949ddc6c32 100644 --- a/packages/shared-ux/page/kibana_no_data/src/mocks.ts +++ b/packages/shared-ux/page/kibana_no_data/src/mocks.ts @@ -14,6 +14,12 @@ import { getNoDataViewsPromptMockServices, } from '@kbn/shared-ux-prompt-no-data-views'; +import { + getNoDataCardMockServices, + getNoDataCardStoryArgTypes, + getNoDataCardStoryServices, +} from '@kbn/shared-ux-card-no-data'; + import { KibanaNoDataPageServices } from './services'; // TODO: clintandrewhall - this looks (and is) a bit complicated because the No Data View @@ -32,6 +38,8 @@ export const getStoryServices = (params: StoryParams) => { const { canCreateNewDataView, dataViewsDocLink, openDataViewEditor } = getNoDataViewsPromptStorybookServices(params); + const { addBasePath, canAccessFleet } = getNoDataCardStoryServices(params); + // Workaround to leverage the services package. const { application, data, docLinks, editors, http, permissions, platform } = servicesFactory(params); @@ -47,6 +55,8 @@ export const getStoryServices = (params: StoryParams) => { canCreateNewDataView, dataViewsDocLink, openDataViewEditor, + addBasePath, + canAccessFleet, }; return services; @@ -75,6 +85,7 @@ export const getStoryArgTypes = () => ({ defaultValue: false, }, ...getNoDataViewsPromptStoryArgTypes(), + ...getNoDataCardStoryArgTypes(), }); /** @@ -84,6 +95,8 @@ export const getMockServices = (params?: MockServicesFactoryParams) => { const { canCreateNewDataView, dataViewsDocLink, openDataViewEditor } = getNoDataViewsPromptMockServices(); + const { addBasePath, canAccessFleet } = getNoDataCardMockServices(); + const { application, data, docLinks, editors, http, permissions, platform } = mockServicesFactory(params); @@ -98,6 +111,8 @@ export const getMockServices = (params?: MockServicesFactoryParams) => { canCreateNewDataView, dataViewsDocLink, openDataViewEditor, + addBasePath, + canAccessFleet, }; return services; diff --git a/packages/shared-ux/page/kibana_no_data/src/services.tsx b/packages/shared-ux/page/kibana_no_data/src/services.tsx index 07b5787ae8b72..47f6b9c3690f9 100644 --- a/packages/shared-ux/page/kibana_no_data/src/services.tsx +++ b/packages/shared-ux/page/kibana_no_data/src/services.tsx @@ -13,6 +13,8 @@ import { NoDataViewsPromptKibanaProvider, } from '@kbn/shared-ux-prompt-no-data-views'; +import { NoDataCardProvider, NoDataCardKibanaProvider } from '@kbn/shared-ux-card-no-data'; + import { LegacyServicesProvider, getLegacyServices } from './legacy_services'; /** @@ -85,7 +87,9 @@ export const KibanaNoDataPageProvider: FC = ({ }) => ( - {children} + + {children} + ); @@ -159,7 +163,9 @@ export const KibanaNoDataPageKibanaProvider: FC - {children} + + {children} + ); diff --git a/scripts/check_published_api_changes.js b/scripts/check_published_api_changes.js deleted file mode 100644 index 44d98ca51361b..0000000000000 --- a/scripts/check_published_api_changes.js +++ /dev/null @@ -1,10 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -require('../src/setup_node_env'); -require('../src/dev/run_check_published_api_changes'); diff --git a/src/core/README.md b/src/core/README.md index 4dd045f37b483..08dd2f49f7f72 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -32,17 +32,3 @@ by the "legacy" Kibana may be rejected by the `core` now. `core` has its own [logging system](./server/logging/README.mdx) and will output log records directly (e.g. to file or terminal) when configured. When no specific configuration is provided, logs are forwarded to the "legacy" Kibana so that they look the same as the rest of the log records throughout Kibana. - -## Core API Review -To provide a stable API for plugin developers, it is important that the Core Public and Server API's are stable and -well documented. To reduce the chance of regressions, development on the Core API's includes an API signature review -process described below. Changes to the API signature which have not been accepted will cause the build to fail. - -When changes to the Core API's signatures are made, the following process needs to be followed: -1. After changes have been made, run `yarn docs:acceptApiChanges` which performs the following: - - Recompiles all typescript typings files - - Updates the API review files `src/core/public/kibana.api.md` and `src/core/server/kibana.api.md` - - Updates the Core API documentation in `docs/development/core/` -2. Review and commit the updated API Review files and documentation -3. Clearly flag any breaking changes in your pull request - diff --git a/src/dev/run_check_published_api_changes.ts b/src/dev/run_check_published_api_changes.ts deleted file mode 100644 index 7ca27e51dd4b5..0000000000000 --- a/src/dev/run_check_published_api_changes.ts +++ /dev/null @@ -1,288 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { ToolingLog } from '@kbn/tooling-log'; -import { getTimeReporter } from '@kbn/ci-stats-reporter'; -import { - Extractor, - IConfigFile, - ExtractorLogLevel, - ExtractorConfig, - ExtractorResult, - ExtractorMessage, -} from '@microsoft/api-extractor'; -import chalk from 'chalk'; -import dedent from 'dedent'; -import execa from 'execa'; -import fs from 'fs'; -import path from 'path'; -import getopts from 'getopts'; - -const log = new ToolingLog({ - level: 'info', - writeTo: process.stdout, -}); - -const runStartTime = Date.now(); -const reportTime = getTimeReporter(log, 'scripts/check_published_api_changes'); - -/* - * Step 1: execute build:types - * This users tsconfig.types.json to generate types in `target/types` - * Step 2: run Api Extractor to detect API changes - * Step 3: generate new docs if needed - */ - -const getReportFileName = (folder: string) => { - switch (true) { - case folder.includes('public'): - return 'public'; - case folder.includes('server'): - return 'server'; - case folder.includes('common'): - return 'common'; - default: - throw new Error( - `folder "${folder}" expected to include one of ["public", "server", "common"]` - ); - } -}; - -const apiExtractorConfig = (folder: string): ExtractorConfig => { - const fname = getReportFileName(folder); - const config: IConfigFile = { - newlineKind: 'lf', - compiler: { - tsconfigFilePath: '/tsconfig.json', - }, - projectFolder: path.resolve('./'), - mainEntryPointFilePath: `target/types/${folder}/index.d.ts`, - apiReport: { - enabled: true, - reportFileName: `${fname}.api.md`, - reportFolder: `/src/${folder}/`, - reportTempFolder: `/build/${folder}/`, - }, - docModel: { - enabled: true, - apiJsonFilePath: `./build/${folder}/${fname}.api.json`, - }, - tsdocMetadata: { - enabled: false, - }, - messages: { - extractorMessageReporting: { - default: { - logLevel: 'warning' as ExtractorLogLevel.Warning, - addToApiReportFile: true, - }, - 'ae-internal-missing-underscore': { - logLevel: 'none' as ExtractorLogLevel.None, - addToApiReportFile: false, - }, - }, - }, - }; - const cfg = ExtractorConfig.prepare({ - configObject: config, - configObjectFullPath: undefined, - packageJsonFullPath: path.resolve('package.json'), - }); - - return cfg; -}; - -const runBuildTypes = async () => { - await execa('yarn', ['run', 'build:types']); -}; - -const runApiDocumenter = async (folder: string) => { - const sourceFolder = `./build/${folder}`; - const targetFolder = `./docs/development/${folder}`; - log.info(`Generating docs from ${sourceFolder} into ${targetFolder}...`); - await execa('api-documenter', ['generate', '-i', sourceFolder, '-o', targetFolder], { - preferLocal: true, - }); -}; - -const renameExtractedApiPackageName = async (folder: string) => { - const fname = getReportFileName(folder); - const jsonApiFile = `build/${folder}/${fname}.api.json`; - log.info(`Updating ${jsonApiFile}...`); - const json = JSON.parse(fs.readFileSync(jsonApiFile).toString()); - json.name = json.canonicalReference = `kibana-plugin-${folder.replace(/\//g, '-')}`; - fs.writeFileSync(jsonApiFile, JSON.stringify(json, null, 2)); -}; - -/** - * Runs api-extractor with a custom logger in order to extract results from the process - * - */ -const runApiExtractor = (folder: string, acceptChanges: boolean = false): ExtractorResult => { - const config = apiExtractorConfig(folder); - const options = { - // Indicates that API Extractor is running as part of a local build, - // e.g. on developer's machine. For example, if the *.api.md output file - // has differences, it will be automatically overwritten for a - // local build, whereas this should report an error for a production build. - localBuild: acceptChanges, - messageCallback: (message: ExtractorMessage) => { - if (message.messageId === 'console-api-report-not-copied') { - // ConsoleMessageId.ApiReportNotCopied - log.warning(`You have changed the signature of the ${folder} public API`); - log.warning( - 'To accept these changes run `node scripts/check_published_api_changes.js --accept` and then:\n' + - "\t 1. Commit the updated documentation and API review file '" + - config.reportFilePath + - "' \n" + - "\t 2. Describe the change in your PR including whether it's a major, minor or patch" - ); - message.handled = true; - } else if (message.messageId === 'console-api-report-copied') { - // ConsoleMessageId.ApiReportCopied - log.warning(`You have changed the signature of the ${folder} public API`); - log.warning( - "Please commit the updated API documentation and the API review file: '" + - config.reportFilePath - ); - message.handled = true; - } else if (message.messageId === 'console-api-report-unchanged') { - // ConsoleMessageId.ApiReportUnchanged - log.info(`${folder} API: no changes detected ✔`); - message.handled = true; - } - }, - }; - - return Extractor.invoke(config, options); -}; - -interface Options { - accept: boolean; - docs: boolean; - help: boolean; - filter: string; -} - -async function run(folder: string, { opts }: { opts: Options }): Promise { - log.info(`${folder} API: checking for changes in API signature...`); - - const { apiReportChanged, succeeded } = runApiExtractor(folder, opts.accept); - - // If we're not accepting changes and there's a failure, exit. - if (!opts.accept && !succeeded) { - return false; - } - - // Attempt to generate docs even if api-extractor didn't succeed - if ((opts.accept && apiReportChanged) || opts.docs) { - try { - await renameExtractedApiPackageName(folder); - await runApiDocumenter(folder); - } catch (e) { - log.error(e); - return false; - } - - log.info(`${folder} API: updated documentation ✔`); - } - - // If the api signature changed or any errors or warnings occured, exit with an error - // NOTE: Because of https://github.com/Microsoft/web-build-tools/issues/1258 - // api-extractor will not return `succeeded: false` when the API changes. - return !apiReportChanged && succeeded; -} - -(async () => { - const extraFlags: string[] = []; - const opts = getopts(process.argv.slice(2), { - boolean: ['accept', 'docs', 'help'], - string: ['filter'], - default: { - project: undefined, - }, - unknown(name) { - extraFlags.push(name); - return false; - }, - }) as any as Options; - - if (extraFlags.length > 0) { - for (const flag of extraFlags) { - log.error(`Unknown flag: ${flag}`); - } - - opts.help = true; - } - - const folders = ['core/public', 'core/server']; - - if (opts.help) { - process.stdout.write( - dedent(chalk` - {dim usage:} node scripts/check_published_api_changes [...options] - - Checks for any changes to the Kibana shared API - - Examples: - - {dim # Checks for any changes to the Kibana shared API} - {dim $} node scripts/check_published_api_changes - - {dim # Checks for any changes to the Kibana shared API and updates the documentation} - {dim $} node scripts/check_published_api_changes --docs - - {dim # Checks for and automatically accepts and updates documentation for any changes to the Kibana shared API} - {dim $} node scripts/check_published_api_changes --accept - - {dim # Only checks the core/public directory} - {dim $} node scripts/check_published_api_changes --filter=core/public - - Options: - --accept {dim Accepts all changes by updating the API Review files and documentation} - --docs {dim Updates the API documentation} - --filter {dim RegExp that folder names must match, folders: [${folders.join(', ')}]} - --help {dim Show this message} - `) - ); - process.stdout.write('\n'); - return !(extraFlags.length > 0); - } - - log.info('Building types for api extractor...'); - await runBuildTypes(); - log.info('Types for api extractor has been built'); - - const filteredFolders = folders.filter((folder) => - opts.filter.length ? folder.match(opts.filter) : true - ); - const results = []; - for (const folder of filteredFolders) { - results.push(await run(folder, { opts })); - } - - if (results.includes(false)) { - reportTime(runStartTime, 'error', { - success: false, - ...opts, - }); - process.exitCode = 1; - } else { - reportTime(runStartTime, 'total', { - success: true, - ...opts, - }); - } -})().catch((e) => { - reportTime(runStartTime, 'error', { - success: false, - error: e.message, - }); - log.error(e); - process.exitCode = 1; -}); diff --git a/src/plugins/controls/common/control_types/options_list/types.ts b/src/plugins/controls/common/control_types/options_list/types.ts index 7ab1c3c4f67a0..4b805210f37d3 100644 --- a/src/plugins/controls/common/control_types/options_list/types.ts +++ b/src/plugins/controls/common/control_types/options_list/types.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import { TimeRange } from '@kbn/data-plugin/common'; -import { Filter, Query, BoolQuery } from '@kbn/es-query'; +import type { Filter, Query, BoolQuery, TimeRange } from '@kbn/es-query'; import { FieldSpec, DataView, DataViewField } from '@kbn/data-views-plugin/common'; import { DataControlInput } from '../../types'; diff --git a/src/plugins/controls/common/types.ts b/src/plugins/controls/common/types.ts index 7d70f53c32933..e98a46ff7a1af 100644 --- a/src/plugins/controls/common/types.ts +++ b/src/plugins/controls/common/types.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import { Filter, Query } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { Filter, Query, TimeRange } from '@kbn/es-query'; import { EmbeddableInput } from '@kbn/embeddable-plugin/common/types'; export type ControlWidth = 'small' | 'medium' | 'large'; diff --git a/src/plugins/controls/public/services/kibana/options_list.ts b/src/plugins/controls/public/services/kibana/options_list.ts index 050972f6234ef..aa3f28e24ab16 100644 --- a/src/plugins/controls/public/services/kibana/options_list.ts +++ b/src/plugins/controls/public/services/kibana/options_list.ts @@ -9,8 +9,7 @@ import { memoize } from 'lodash'; import dateMath from '@kbn/datemath'; -import { buildEsQuery } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/public'; +import { buildEsQuery, type TimeRange } from '@kbn/es-query'; import { KibanaPluginServiceFactory } from '@kbn/presentation-util-plugin/public'; import { diff --git a/src/plugins/dashboard/public/locator.ts b/src/plugins/dashboard/public/locator.ts index ebf7b13a9563a..240723ca47bce 100644 --- a/src/plugins/dashboard/public/locator.ts +++ b/src/plugins/dashboard/public/locator.ts @@ -8,13 +8,8 @@ import type { SerializableRecord } from '@kbn/utility-types'; import { flow } from 'lodash'; -import { type Filter } from '@kbn/es-query'; -import type { - TimeRange, - Query, - GlobalQueryStateFromUrl, - RefreshInterval, -} from '@kbn/data-plugin/public'; +import type { Filter, TimeRange, Query } from '@kbn/es-query'; +import type { GlobalQueryStateFromUrl, RefreshInterval } from '@kbn/data-plugin/public'; import type { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/public'; import { SerializableControlGroupInput } from '@kbn/controls-plugin/common'; import { setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public'; diff --git a/src/plugins/dashboard/public/services/data.ts b/src/plugins/dashboard/public/services/data.ts index da5f4e12299db..1e0c02cc3d401 100644 --- a/src/plugins/dashboard/public/services/data.ts +++ b/src/plugins/dashboard/public/services/data.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ +export type { Query, TimeRange, Filter } from '@kbn/es-query'; export * from '@kbn/data-plugin/public'; diff --git a/src/plugins/data/common/es_query/index.ts b/src/plugins/data/common/es_query/index.ts index b548fd9390592..d844c3acdadf5 100644 --- a/src/plugins/data/common/es_query/index.ts +++ b/src/plugins/data/common/es_query/index.ts @@ -7,388 +7,3 @@ */ export { getEsQueryConfig } from './get_es_query_config'; - -// NOTE: Trick to deprecate exports https://stackoverflow.com/a/49152018/372086 -import { - enableFilter as oldEnableFilter, - pinFilter as oldPinFilter, - toggleFilterDisabled as oldToggleFilterDisabled, - isFilterDisabled as oldIsFilterDisabled, - disableFilter as oldDisableFilter, - fromKueryExpression as oldFromKueryExpression, - toElasticsearchQuery as oldToElasticsearchQuery, - buildEsQuery as oldBuildEsQuery, - buildQueryFromFilters as oldBuildQueryFromFilters, - luceneStringToDsl as oldLuceneStringToDsl, - decorateQuery as olddecorateQuery, - getPhraseFilterField as oldgetPhraseFilterField, - getPhraseFilterValue as oldgetPhraseFilterValue, - isFilterPinned as oldIsFilterPinned, - nodeBuilder as oldNodeBuilder, - isFilters as oldIsFilters, - isExistsFilter as oldIsExistsFilter, - isMatchAllFilter as oldIsMatchAllFilter, - isPhraseFilter as oldIsPhraseFilter, - isPhrasesFilter as oldIsPhrasesFilter, - isRangeFilter as oldIsRangeFilter, - isQueryStringFilter as oldIsQueryStringFilter, - buildQueryFilter as oldBuildQueryFilter, - buildPhrasesFilter as oldBuildPhrasesFilter, - buildPhraseFilter as oldBuildPhraseFilter, - buildRangeFilter as oldBuildRangeFilter, - buildCustomFilter as oldBuildCustomFilter, - buildFilter as oldBuildFilter, - buildEmptyFilter as oldBuildEmptyFilter, - buildExistsFilter as oldBuildExistsFilter, - toggleFilterNegated as oldtoggleFilterNegated, - Filter as oldFilter, - RangeFilterParams as oldRangeFilterParams, - ExistsFilter as oldExistsFilter, - PhraseFilter as oldPhraseFilter, - MatchAllFilter as oldMatchAllFilter, - RangeFilter as oldRangeFilter, - KueryNode as oldKueryNode, - TimeRange as oldTimeRange, - FilterMeta as oldFilterMeta, - FILTERS as oldFILTERS, - EsQueryConfig as oldEsQueryConfig, - compareFilters as oldCompareFilters, - COMPARE_ALL_OPTIONS as OLD_COMPARE_ALL_OPTIONS, - dedupFilters as oldDedupFilters, - onlyDisabledFiltersChanged as oldOnlyDisabledFiltersChanged, - uniqFilters as oldUniqFilters, - FilterStateStore, -} from '@kbn/es-query'; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isFilterDisabled = oldIsFilterDisabled; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const disableFilter = oldDisableFilter; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const fromKueryExpression = oldFromKueryExpression; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const toElasticsearchQuery = oldToElasticsearchQuery; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildEsQuery = oldBuildEsQuery; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildQueryFromFilters = oldBuildQueryFromFilters; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const luceneStringToDsl = oldLuceneStringToDsl; -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const decorateQuery = olddecorateQuery; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const getPhraseFilterField = oldgetPhraseFilterField; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const getPhraseFilterValue = oldgetPhraseFilterValue; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isFilterPinned = oldIsFilterPinned; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const nodeBuilder = oldNodeBuilder; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isFilters = oldIsFilters; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const uniqFilters = oldUniqFilters; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const onlyDisabledFiltersChanged = oldOnlyDisabledFiltersChanged; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isExistsFilter = oldIsExistsFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isMatchAllFilter = oldIsMatchAllFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isPhraseFilter = oldIsPhraseFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isPhrasesFilter = oldIsPhrasesFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isRangeFilter = oldIsRangeFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const isQueryStringFilter = oldIsQueryStringFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildQueryFilter = oldBuildQueryFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildPhrasesFilter = oldBuildPhrasesFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildPhraseFilter = oldBuildPhraseFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildRangeFilter = oldBuildRangeFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildCustomFilter = oldBuildCustomFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildFilter = oldBuildFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildEmptyFilter = oldBuildEmptyFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const buildExistsFilter = oldBuildExistsFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const toggleFilterNegated = oldtoggleFilterNegated; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const enableFilter = oldEnableFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const pinFilter = oldPinFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const toggleFilterDisabled = oldToggleFilterDisabled; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const compareFilters = oldCompareFilters; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const dedupFilters = oldDedupFilters; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const COMPARE_ALL_OPTIONS = OLD_COMPARE_ALL_OPTIONS; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -const FILTERS = oldFILTERS; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type Filter = oldFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type RangeFilterParams = oldRangeFilterParams; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type ExistsFilter = oldExistsFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type PhraseFilter = oldPhraseFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type MatchAllFilter = oldMatchAllFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type RangeFilter = oldRangeFilter; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type KueryNode = oldKueryNode; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type FilterMeta = oldFilterMeta; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -type EsQueryConfig = oldEsQueryConfig; - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ - -/** - * @deprecated Import from the "@kbn/es-query" package directly instead. - * @removeBy 8.3 - */ -type TimeRange = oldTimeRange; - -export type { - Filter, - RangeFilterParams, - ExistsFilter, - PhraseFilter, - MatchAllFilter, - RangeFilter, - KueryNode, - FilterMeta, - EsQueryConfig, - TimeRange, -}; -export { - COMPARE_ALL_OPTIONS, - compareFilters, - enableFilter, - pinFilter, - toggleFilterDisabled, - disableFilter, - fromKueryExpression, - toElasticsearchQuery, - buildEsQuery, - buildQueryFromFilters, - luceneStringToDsl, - decorateQuery, - getPhraseFilterField, - getPhraseFilterValue, - isFilterPinned, - nodeBuilder, - isFilters, - isExistsFilter, - isMatchAllFilter, - isPhraseFilter, - isPhrasesFilter, - isRangeFilter, - isQueryStringFilter, - buildQueryFilter, - buildPhrasesFilter, - buildPhraseFilter, - buildRangeFilter, - buildCustomFilter, - buildFilter, - buildEmptyFilter, - buildExistsFilter, - toggleFilterNegated, - FILTERS, - isFilterDisabled, - dedupFilters, - onlyDisabledFiltersChanged, - uniqFilters, - FilterStateStore, -}; diff --git a/src/plugins/data/common/es_query/stubs/exists_filter.ts b/src/plugins/data/common/es_query/stubs/exists_filter.ts index 82df9b73abdd3..89ab73f185495 100644 --- a/src/plugins/data/common/es_query/stubs/exists_filter.ts +++ b/src/plugins/data/common/es_query/stubs/exists_filter.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { ExistsFilter, FilterStateStore } from '..'; +import { ExistsFilter, FilterStateStore } from '@kbn/es-query'; export const existsFilter: ExistsFilter = { meta: { diff --git a/src/plugins/data/common/index.ts b/src/plugins/data/common/index.ts index 4f88c6accea83..478d6d23d7b96 100644 --- a/src/plugins/data/common/index.ts +++ b/src/plugins/data/common/index.ts @@ -12,59 +12,7 @@ export { DEFAULT_QUERY_LANGUAGE, KIBANA_USER_QUERY_LANGUAGE_KEY, UI_SETTINGS } from './constants'; export type { ValueSuggestionsMethod } from './constants'; export { DatatableUtilitiesService } from './datatable_utilities'; -export { - buildEmptyFilter, - buildCustomFilter, - buildExistsFilter, - buildPhraseFilter, - buildPhrasesFilter, - buildQueryFilter, - buildQueryFromFilters, - buildRangeFilter, - buildFilter, - buildEsQuery, - getPhraseFilterField, - getPhraseFilterValue, - isExistsFilter, - compareFilters, - dedupFilters, - disableFilter, - enableFilter, - isPhraseFilter, - isFilters, - isQueryStringFilter, - isRangeFilter, - isPhrasesFilter, - decorateQuery, - fromKueryExpression, - isFilterDisabled, - isFilterPinned, - isMatchAllFilter, - FilterStateStore, - COMPARE_ALL_OPTIONS, - FILTERS, - getEsQueryConfig, - luceneStringToDsl, - nodeBuilder, - onlyDisabledFiltersChanged, - pinFilter, - toElasticsearchQuery, - toggleFilterDisabled, - toggleFilterNegated, - uniqFilters, -} from './es_query'; -export type { - ExistsFilter, - Filter, - MatchAllFilter, - FilterMeta, - PhraseFilter, - RangeFilter, - RangeFilterParams, - KueryNode, - EsQueryConfig, - TimeRange, -} from './es_query'; +export { getEsQueryConfig } from './es_query'; export { KbnFieldType } from './kbn_field_types'; export { calculateBounds, diff --git a/src/plugins/data/common/query/timefilter/get_time.ts b/src/plugins/data/common/query/timefilter/get_time.ts index 447d4b16e799f..3c5d7a6d37d35 100644 --- a/src/plugins/data/common/query/timefilter/get_time.ts +++ b/src/plugins/data/common/query/timefilter/get_time.ts @@ -9,10 +9,10 @@ import { KBN_FIELD_TYPES } from '@kbn/field-types'; import dateMath from '@kbn/datemath'; import { omitBy } from 'lodash'; -import { buildRangeFilter } from '@kbn/es-query'; +import { buildRangeFilter, TimeRange, RangeFilterParams } from '@kbn/es-query'; import type { Moment } from 'moment'; import type { DataView } from '@kbn/data-views-plugin/common'; -import type { TimeRange, TimeRangeBounds, RangeFilterParams } from '../..'; +import type { TimeRangeBounds } from '../..'; export interface CalculateBoundsOptions { forceNow?: Date; diff --git a/src/plugins/data/common/search/aggs/agg_configs.ts b/src/plugins/data/common/search/aggs/agg_configs.ts index 65238ee7b4db1..7d1b6e7b03cad 100644 --- a/src/plugins/data/common/search/aggs/agg_configs.ts +++ b/src/plugins/data/common/search/aggs/agg_configs.ts @@ -10,7 +10,7 @@ import moment from 'moment-timezone'; import _, { cloneDeep } from 'lodash'; import { i18n } from '@kbn/i18n'; import type { Assign } from '@kbn/utility-types'; -import { isRangeFilter } from '@kbn/es-query'; +import { isRangeFilter, TimeRange, RangeFilter } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/common'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import type { IndexPatternLoadExpressionFunctionDefinition } from '@kbn/data-views-plugin/common'; @@ -20,7 +20,6 @@ import type { IEsSearchResponse, ISearchOptions, ISearchSource, - RangeFilter, // eslint-disable-next-line @kbn/eslint/no-restricted-paths } from '../../../public'; import type { EsaggsExpressionFunctionDefinition } from '../expressions'; @@ -29,7 +28,7 @@ import type { IAggType } from './agg_type'; import type { AggTypesRegistryStart } from './agg_types_registry'; import { AggGroupNames } from './agg_groups'; import { AggTypesDependencies, GetConfigFn, getUserTimeZone } from '../..'; -import { TimeRange, getTime, calculateBounds } from '../..'; +import { getTime, calculateBounds } from '../..'; import type { IBucketAggConfig } from './buckets'; import { insertTimeShiftSplit, mergeTimeShifts } from './utils/time_splits'; diff --git a/src/plugins/data/common/search/aggs/buckets/date_histogram.ts b/src/plugins/data/common/search/aggs/buckets/date_histogram.ts index d72a0a3f22922..deb676fe96a1b 100644 --- a/src/plugins/data/common/search/aggs/buckets/date_histogram.ts +++ b/src/plugins/data/common/search/aggs/buckets/date_histogram.ts @@ -9,15 +9,9 @@ import { get, noop, find, every, omitBy, isNil } from 'lodash'; import moment from 'moment-timezone'; import { i18n } from '@kbn/i18n'; -import { DataViewFieldBase } from '@kbn/es-query'; +import { DataViewFieldBase, TimeRange } from '@kbn/es-query'; -import { - AggTypesDependencies, - KBN_FIELD_TYPES, - TimeRange, - TimeRangeBounds, - UI_SETTINGS, -} from '../../..'; +import { AggTypesDependencies, KBN_FIELD_TYPES, TimeRangeBounds, UI_SETTINGS } from '../../..'; import { ExtendedBounds, extendedBoundsToAst, timerangeToAst } from '../../expressions'; import { intervalOptions, autoInterval, isAutoInterval } from './_interval_options'; diff --git a/src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts b/src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts index 308f46551af30..85d7e852b468c 100644 --- a/src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts +++ b/src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts @@ -7,7 +7,7 @@ */ import dateMath from '@kbn/datemath'; -import { TimeRange } from '../../../..'; +import type { TimeRange } from '@kbn/es-query'; export function toAbsoluteDates(range: TimeRange) { const fromDate = dateMath.parse(range.from); diff --git a/src/plugins/data/common/search/expressions/esaggs/create_filter.ts b/src/plugins/data/common/search/expressions/esaggs/create_filter.ts index 9030cd7623ef7..4673468fcc306 100644 --- a/src/plugins/data/common/search/expressions/esaggs/create_filter.ts +++ b/src/plugins/data/common/search/expressions/esaggs/create_filter.ts @@ -7,7 +7,7 @@ */ import { Datatable } from '@kbn/expressions-plugin/common'; -import { Filter } from '../../../es_query'; +import type { Filter } from '@kbn/es-query'; import { IAggConfig } from '../../aggs'; const getOtherBucketFilterTerms = (table: Datatable, columnIndex: number, rowIndex: number) => { diff --git a/src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts b/src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts index 4f112c3f64206..2c91a8f5ecfc7 100644 --- a/src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts +++ b/src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts @@ -8,7 +8,7 @@ import { from } from 'rxjs'; import type { MockedKeys } from '@kbn/utility-types-jest'; -import type { Filter } from '../../../es_query'; +import type { Filter } from '@kbn/es-query'; import type { IAggConfigs } from '../../aggs'; import type { ISearchSource } from '../../search_source'; import { searchSourceCommonMock, searchSourceInstanceMock } from '../../search_source/mocks'; diff --git a/src/plugins/data/common/search/expressions/esaggs/request_handler.ts b/src/plugins/data/common/search/expressions/esaggs/request_handler.ts index 8caa93c4461ef..7e92f0633d045 100644 --- a/src/plugins/data/common/search/expressions/esaggs/request_handler.ts +++ b/src/plugins/data/common/search/expressions/esaggs/request_handler.ts @@ -11,8 +11,9 @@ import { defer } from 'rxjs'; import { map, switchMap } from 'rxjs/operators'; import { Adapters } from '@kbn/inspector-plugin/common'; import type { DataView } from '@kbn/data-views-plugin/common'; +import type { Filter, TimeRange } from '@kbn/es-query'; -import { calculateBounds, Filter, Query, TimeRange } from '../../..'; +import { calculateBounds, Query } from '../../..'; import { IAggConfigs } from '../../aggs'; import { ISearchStartSearchSource } from '../../search_source'; diff --git a/src/plugins/data/common/search/search_source/create_search_source.test.ts b/src/plugins/data/common/search/search_source/create_search_source.test.ts index c67e8a21b4f9a..491673dc8ebca 100644 --- a/src/plugins/data/common/search/search_source/create_search_source.test.ts +++ b/src/plugins/data/common/search/search_source/create_search_source.test.ts @@ -9,7 +9,7 @@ import { createSearchSource as createSearchSourceFactory } from './create_search_source'; import { SearchSourceDependencies } from './search_source'; import type { DataView, DataViewsContract } from '@kbn/data-views-plugin/common'; -import { Filter } from '../../es_query'; +import type { Filter } from '@kbn/es-query'; describe('createSearchSource', () => { const indexPatternMock: DataView = {} as DataView; diff --git a/src/plugins/data/common/search/search_source/types.ts b/src/plugins/data/common/search/search_source/types.ts index 3861ef18da6ce..3f199c6b338c4 100644 --- a/src/plugins/data/common/search/search_source/types.ts +++ b/src/plugins/data/common/search/search_source/types.ts @@ -9,11 +9,11 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { SerializableRecord } from '@kbn/utility-types'; import { PersistableStateService } from '@kbn/kibana-utils-plugin/common'; +import type { Filter } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/common'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths import { AggConfigSerialized, IAggConfigs } from '../../../public'; import { Query } from '../..'; -import { Filter } from '../../es_query'; import type { SearchSource } from './search_source'; /** diff --git a/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts b/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts index bcfdf46772dc5..a3211867d94ba 100644 --- a/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts +++ b/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts @@ -9,10 +9,10 @@ import { last } from 'lodash'; import moment from 'moment'; import { Datatable } from '@kbn/expressions-plugin'; -import { DataViewFieldBase } from '@kbn/es-query'; -import { esFilters, RangeFilterParams } from '../..'; +import { buildRangeFilter, DataViewFieldBase, RangeFilterParams } from '@kbn/es-query'; import { getIndexPatterns, getSearchService } from '../../services'; import { AggConfigSerialized } from '../../../common/search/aggs'; +import { mapAndFlattenFilters } from '../../query'; interface RangeSelectDataContext { table: Datatable; @@ -58,5 +58,5 @@ export async function createFiltersFromRangeSelectAction(event: RangeSelectDataC range.format = 'strict_date_optional_time'; } - return esFilters.mapAndFlattenFilters([esFilters.buildRangeFilter(field, range, indexPattern)]); + return mapAndFlattenFilters([buildRangeFilter(field, range, indexPattern)]); } diff --git a/src/plugins/data/public/actions/filters/create_filters_from_value_click.ts b/src/plugins/data/public/actions/filters/create_filters_from_value_click.ts index 1c7ffe5edf58f..d985639dd08c5 100644 --- a/src/plugins/data/public/actions/filters/create_filters_from_value_click.ts +++ b/src/plugins/data/public/actions/filters/create_filters_from_value_click.ts @@ -8,9 +8,10 @@ import _ from 'lodash'; import { Datatable } from '@kbn/expressions-plugin/public'; -import { esFilters, Filter } from '../..'; +import { compareFilters, COMPARE_ALL_OPTIONS, Filter, toggleFilterNegated } from '@kbn/es-query'; import { getIndexPatterns, getSearchService } from '../../services'; import { AggConfigSerialized } from '../../../common/search/aggs'; +import { mapAndFlattenFilters } from '../../query'; interface ValueClickDataContext { data: Array<{ @@ -135,7 +136,7 @@ export const createFiltersFromValueClickAction = async ({ if (filter) { filter.forEach((f) => { if (negate) { - f = esFilters.toggleFilterNegated(f); + f = toggleFilterNegated(f); } filters.push(f); }); @@ -143,7 +144,7 @@ export const createFiltersFromValueClickAction = async ({ }) ); - return _.uniqWith(esFilters.mapAndFlattenFilters(filters), (a, b) => - esFilters.compareFilters(a, b, esFilters.COMPARE_ALL_OPTIONS) + return _.uniqWith(mapAndFlattenFilters(filters), (a, b) => + compareFilters(a, b, COMPARE_ALL_OPTIONS) ); }; diff --git a/src/plugins/data/public/deprecated.ts b/src/plugins/data/public/deprecated.ts deleted file mode 100644 index 6565e1a1b8cb9..0000000000000 --- a/src/plugins/data/public/deprecated.ts +++ /dev/null @@ -1,140 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -/* - * Filters: - */ - -import { - getPhraseFilterField, - getPhraseFilterValue, - isExistsFilter, - isFilterPinned, - isMatchAllFilter, - isPhraseFilter, - isPhrasesFilter, - isQueryStringFilter, - isRangeFilter, - toggleFilterNegated, - buildEmptyFilter, - buildExistsFilter, - buildPhraseFilter, - buildPhrasesFilter, - buildQueryFilter, - buildRangeFilter, - disableFilter, - fromKueryExpression, - toElasticsearchQuery, - buildEsQuery, - buildQueryFromFilters, - luceneStringToDsl, - decorateQuery, - FILTERS, - isFilters, - KueryNode, - RangeFilter, - RangeFilterParams, - ExistsFilter, - PhraseFilter, - MatchAllFilter, - EsQueryConfig, - FilterStateStore, - compareFilters, - COMPARE_ALL_OPTIONS, - onlyDisabledFiltersChanged, - getEsQueryConfig, - TimeRange, -} from '../common'; - -import { - getDisplayValueFromFilter, - generateFilters, - mapAndFlattenFilters as oldMapAndFlattenFilters, -} from './query'; - -/** - * @deprecated This import will be removed. - * @removeBy 8.1 - */ -const mapAndFlattenFilters = oldMapAndFlattenFilters; - -/** - * Filter helpers namespace: - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esFilters = { - FILTERS, - FilterStateStore, - - buildEmptyFilter, - buildPhrasesFilter, - buildExistsFilter, - buildPhraseFilter, - buildQueryFilter, - buildRangeFilter, - - isPhraseFilter, - isExistsFilter, - isPhrasesFilter, - isRangeFilter, - isMatchAllFilter, - isQueryStringFilter, - isFilterPinned, - - toggleFilterNegated, - disableFilter, - getPhraseFilterField, - getPhraseFilterValue, - getDisplayValueFromFilter, - - compareFilters, - COMPARE_ALL_OPTIONS, - generateFilters, - onlyDisabledFiltersChanged, - - mapAndFlattenFilters, -}; - -/** - * Deprecated type exports - */ -export type { - KueryNode, - RangeFilter, - RangeFilterParams, - ExistsFilter, - PhraseFilter, - MatchAllFilter, - EsQueryConfig, - TimeRange, -}; -export { isFilters }; - -/** - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esKuery = { - fromKueryExpression, - toElasticsearchQuery, -}; - -/** - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esQuery = { - buildEsQuery, - getEsQueryConfig, - buildQueryFromFilters, - luceneStringToDsl, - decorateQuery, -}; - -export type { Filter, Query } from '../common'; diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts index 89f02906657ef..c26b5a6ad8114 100644 --- a/src/plugins/data/public/index.ts +++ b/src/plugins/data/public/index.ts @@ -6,19 +6,14 @@ * Side Public License, v 1. */ -// TODO: https://github.com/elastic/kibana/issues/109904 -/* eslint-disable @kbn/eslint/no_export_all */ - import { PluginInitializerContext } from '@kbn/core/public'; import { ConfigSchema } from '../config'; -export * from './deprecated'; - /* * Filters: */ -export { getEsQueryConfig, FilterStateStore } from '../common'; +export { getEsQueryConfig } from '../common'; export { getDisplayValueFromFilter, getFieldDisplayValueFromFilter, @@ -236,7 +231,7 @@ export const search = { * Types to be shared externally * @public */ -export type { RefreshInterval, TimeRange } from '../common'; +export type { RefreshInterval } from '../common'; export { createSavedQueryService, diff --git a/src/plugins/data/public/query/filter_manager/filter_manager.test.ts b/src/plugins/data/public/query/filter_manager/filter_manager.test.ts index 9620d79295220..9f72efaec9cda 100644 --- a/src/plugins/data/public/query/filter_manager/filter_manager.test.ts +++ b/src/plugins/data/public/query/filter_manager/filter_manager.test.ts @@ -8,12 +8,13 @@ import _ from 'lodash'; import sinon from 'sinon'; +import { Filter, FilterStateStore } from '@kbn/es-query'; import { Subscription } from 'rxjs'; import { FilterManager } from './filter_manager'; import { getFilter } from './test_helpers/get_stub_filter'; import { getFiltersArray } from './test_helpers/get_filters_array'; -import { Filter, FilterStateStore, UI_SETTINGS } from '../../../common'; +import { UI_SETTINGS } from '../../../common'; import { coreMock } from '@kbn/core/public/mocks'; const setupMock = coreMock.createSetup(); diff --git a/src/plugins/data/public/query/filter_manager/filter_manager.ts b/src/plugins/data/public/query/filter_manager/filter_manager.ts index cf9ad750d2809..c3a2c52ac60df 100644 --- a/src/plugins/data/public/query/filter_manager/filter_manager.ts +++ b/src/plugins/data/public/query/filter_manager/filter_manager.ts @@ -10,6 +10,7 @@ import _ from 'lodash'; import { Subject } from 'rxjs'; import { IUiSettingsClient } from '@kbn/core/public'; +import { FilterStateStore } from '@kbn/es-query'; import { isFilterPinned, @@ -23,7 +24,7 @@ import { PersistableStateService } from '@kbn/kibana-utils-plugin/common/persist import { sortFilters } from './lib/sort_filters'; import { mapAndFlattenFilters } from './lib/map_and_flatten_filters'; -import { FilterStateStore, UI_SETTINGS } from '../../../common'; +import { UI_SETTINGS } from '../../../common'; import { getAllMigrations, inject, diff --git a/src/plugins/data/public/query/filter_manager/lib/generate_filter.test.ts b/src/plugins/data/public/query/filter_manager/lib/generate_filter.test.ts index 2b00ff41e9516..af181d2d94fda 100644 --- a/src/plugins/data/public/query/filter_manager/lib/generate_filter.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/generate_filter.test.ts @@ -22,6 +22,7 @@ import { } from '@kbn/es-query'; const INDEX_NAME = 'my-index'; +const MOCKED_INDEX = { id: INDEX_NAME } as unknown as DataViewBase; const EXISTS_FIELD_NAME = '_exists_'; const FIELD = { name: 'my-field', @@ -47,7 +48,7 @@ describe('Generate filters', () => { EXISTS_FIELD_NAME, FIELD.name, '', - INDEX_NAME + MOCKED_INDEX ); expect(filters).toHaveLength(1); expect(filters[0].meta.index === INDEX_NAME); @@ -61,7 +62,7 @@ describe('Generate filters', () => { EXISTS_FIELD_NAME, FIELD.name, '-', - INDEX_NAME + MOCKED_INDEX ); expect(filters).toHaveLength(1); expect(filters[0].meta.index === INDEX_NAME); @@ -74,7 +75,7 @@ describe('Generate filters', () => { filter.meta.disabled = true; filtersArray.push(filter); - const filters = generateFilters(mockFilterManager, '_exists_', FIELD.name, '-', INDEX_NAME); + const filters = generateFilters(mockFilterManager, '_exists_', FIELD.name, '-', MOCKED_INDEX); expect(filters).toHaveLength(1); expect(filters[0].meta.index === INDEX_NAME); expect(filters[0].meta.negate).toBeTruthy(); @@ -83,7 +84,7 @@ describe('Generate filters', () => { }); it('should create phrase filter', () => { - const filters = generateFilters(mockFilterManager, FIELD, PHRASE_VALUE, '', INDEX_NAME); + const filters = generateFilters(mockFilterManager, FIELD, PHRASE_VALUE, '', MOCKED_INDEX); expect(filters).toHaveLength(1); const [filter] = filters as PhraseFilter[]; @@ -96,7 +97,7 @@ describe('Generate filters', () => { }); it('should create negated phrase filter', () => { - const filters = generateFilters(mockFilterManager, FIELD, PHRASE_VALUE, '-', INDEX_NAME); + const filters = generateFilters(mockFilterManager, FIELD, PHRASE_VALUE, '-', MOCKED_INDEX); expect(filters).toHaveLength(1); const [filter] = filters as PhraseFilter[]; expect(filter.meta.index === INDEX_NAME); @@ -119,7 +120,7 @@ describe('Generate filters', () => { lte: '192.168.255.255', }, '+', - INDEX_NAME + MOCKED_INDEX ) as RangeFilter[]; expect(filters).toHaveLength(1); const [filter] = filters; @@ -143,7 +144,7 @@ describe('Generate filters', () => { } as DataViewFieldBase, 10000, '+', - INDEX_NAME + MOCKED_INDEX ); expect(filters).toHaveLength(1); @@ -164,7 +165,7 @@ describe('Generate filters', () => { FIELD, [PHRASE_VALUE, ANOTHER_PHRASE], '', - INDEX_NAME + MOCKED_INDEX ); expect(filters).toHaveLength(2); expect(filters[0].meta.index === INDEX_NAME); @@ -188,7 +189,7 @@ describe('Generate filters', () => { FIELD, [PHRASE_VALUE, ANOTHER_PHRASE, PHRASE_VALUE, ANOTHER_PHRASE], '', - INDEX_NAME + MOCKED_INDEX ); expect(filters).toHaveLength(2); expect(filters[0].query?.match_phrase).toEqual({ diff --git a/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts b/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts index e0d29a560a436..8b405a2a6ae4b 100644 --- a/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts +++ b/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts @@ -18,8 +18,8 @@ import { FilterStateStore, FILTERS, DataViewFieldBase, + DataViewBase, } from '@kbn/es-query'; -import type { DataView } from '@kbn/data-views-plugin/common'; import { FilterManager } from '../filter_manager'; @@ -72,7 +72,7 @@ export function generateFilters( field: DataViewFieldBase | string, values: any, operation: string, - index: string + index: DataViewBase ): Filter[] { values = Array.isArray(values) ? _.uniq(values) : [values]; const fieldObj = ( @@ -96,12 +96,8 @@ export function generateFilters( updateExistingFilter(existing, negate); filter = existing; } else if (fieldObj.type?.includes('range') && value && typeof value === 'object') { - // When dealing with range fields, the filter type depends on the data passed in. If it's an - // object we assume that it's a min/max value - const tmpIndexPattern = { id: index } as DataView; - filter = buildFilter( - tmpIndexPattern, + index, fieldObj, FILTERS.RANGE_FROM_VALUE, false, @@ -111,7 +107,6 @@ export function generateFilters( FilterStateStore.APP_STATE ); } else { - const tmpIndexPattern = { id: index } as DataView; // exists filter special case: fieldname = '_exists' and value = fieldname const filterType = fieldName === '_exists_' ? FILTERS.EXISTS : FILTERS.PHRASE; const actualFieldObj = @@ -121,7 +116,7 @@ export function generateFilters( const isNullFilter = value === null || value === undefined; filter = buildFilter( - tmpIndexPattern, + index, actualFieldObj, isNullFilter ? FILTERS.EXISTS : filterType, isNullFilter ? !negate : negate, diff --git a/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.test.ts b/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.test.ts index 1aa14f89a88e7..7c86581b42a6b 100644 --- a/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.test.ts @@ -8,7 +8,7 @@ import sinon from 'sinon'; import { generateMappingChain } from './generate_mapping_chain'; -import { buildEmptyFilter } from '../../../../common'; +import { buildEmptyFilter } from '@kbn/es-query'; describe('filter manager utilities', () => { let mapping: any; diff --git a/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.ts b/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.ts index b152a4d3ac2a8..2a67e72b5e41f 100644 --- a/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.ts +++ b/src/plugins/data/public/query/filter_manager/lib/generate_mapping_chain.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Filter } from '../../../../common'; +import { Filter } from '@kbn/es-query'; const noop = () => { throw new Error('No mappings have been found for filter.'); diff --git a/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts b/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts index 944a8fc73064a..40bbe9a89c992 100644 --- a/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts +++ b/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts @@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n'; import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; -import { Filter } from '../../../../common'; +import { Filter } from '@kbn/es-query'; import { getIndexPatternFromFilter } from './get_index_pattern_from_filter'; function getValueFormatter(indexPattern?: DataView, key?: string) { diff --git a/src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts b/src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts index 5ecd02b6f9d85..c4da427ed9780 100644 --- a/src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts +++ b/src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts @@ -7,7 +7,7 @@ */ import { DataView } from '@kbn/data-views-plugin/public'; -import { Filter } from '../../../../common'; +import { Filter } from '@kbn/es-query'; export function getIndexPatternFromFilter( filter: Filter, diff --git a/src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.test.ts b/src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.test.ts index 113ae15d8284b..e7b4067881656 100644 --- a/src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.test.ts @@ -7,7 +7,7 @@ */ import { mapAndFlattenFilters } from './map_and_flatten_filters'; -import { Filter } from '../../../../common'; +import type { Filter } from '@kbn/es-query'; describe('filter manager utilities', () => { describe('mapAndFlattenFilters()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/map_filter.test.ts b/src/plugins/data/public/query/filter_manager/lib/map_filter.test.ts index 0deabd6412475..be94e69f74f9d 100644 --- a/src/plugins/data/public/query/filter_manager/lib/map_filter.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/map_filter.test.ts @@ -7,7 +7,7 @@ */ import { mapFilter } from './map_filter'; -import { Filter } from '../../../../common'; +import type { Filter } from '@kbn/es-query'; describe('filter manager utilities', () => { function getDisplayName(filter: Filter) { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_default.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_default.test.ts index 84b8bcc1226e9..74a932ad970a5 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_default.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_default.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ +import { buildQueryFilter, buildEmptyFilter } from '@kbn/es-query'; import { mapDefault } from './map_default'; -import { buildQueryFilter, buildEmptyFilter } from '../../../../../common'; describe('filter manager utilities', () => { describe('mapDefault()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts index 6cac5352af016..0e642b3f99dcc 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts @@ -6,10 +6,9 @@ * Side Public License, v 1. */ +import { buildExistsFilter, buildEmptyFilter, DataViewFieldBase } from '@kbn/es-query'; import { mapExists } from './map_exists'; import { mapQueryString } from './map_query_string'; -import { buildExistsFilter, buildEmptyFilter } from '../../../../../common'; -import { DataViewFieldBase } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/common'; describe('filter manager utilities', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_phrase.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_phrase.test.ts index 2cf4a67a0e401..c63a8f82f1704 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_phrase.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_phrase.test.ts @@ -7,7 +7,7 @@ */ import { mapPhrase } from './map_phrase'; -import { PhraseFilter, Filter } from '../../../../../common'; +import type { PhraseFilter, Filter } from '@kbn/es-query'; describe('filter manager utilities', () => { describe('mapPhrase()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_query_string.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_query_string.test.ts index bdacc3db9007d..f54cea3164919 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_query_string.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_query_string.test.ts @@ -7,7 +7,7 @@ */ import { mapQueryString } from './map_query_string'; -import { buildQueryFilter, buildEmptyFilter, Filter } from '../../../../../common'; +import { buildQueryFilter, buildEmptyFilter, Filter } from '@kbn/es-query'; describe('filter manager utilities', () => { describe('mapQueryString()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_range.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_range.test.ts index 98d70dc86bb35..3b82ee6ef0f1c 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_range.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_range.test.ts @@ -7,7 +7,7 @@ */ import { mapRange } from './map_range'; -import { FilterMeta, RangeFilter, Filter } from '../../../../../common'; +import { FilterMeta, RangeFilter, Filter } from '@kbn/es-query'; describe('filter manager utilities', () => { describe('mapRange()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/mappers/map_spatial_filter.test.ts b/src/plugins/data/public/query/filter_manager/lib/mappers/map_spatial_filter.test.ts index 0ae1513ae5d1b..9065ccfa17856 100644 --- a/src/plugins/data/public/query/filter_manager/lib/mappers/map_spatial_filter.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/mappers/map_spatial_filter.test.ts @@ -7,7 +7,7 @@ */ import { mapSpatialFilter } from './map_spatial_filter'; -import { FilterMeta, Filter, FILTERS } from '../../../../../common'; +import { FilterMeta, Filter, FILTERS } from '@kbn/es-query'; describe('mapSpatialFilter()', () => { test('should return the key for matching multi polygon filter', async () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/sort_filters.test.ts b/src/plugins/data/public/query/filter_manager/lib/sort_filters.test.ts index da765aec708b1..6a17c945e457c 100644 --- a/src/plugins/data/public/query/filter_manager/lib/sort_filters.test.ts +++ b/src/plugins/data/public/query/filter_manager/lib/sort_filters.test.ts @@ -7,7 +7,7 @@ */ import { sortFilters } from './sort_filters'; -import { FilterStateStore, buildQueryFilter } from '../../../../common'; +import { FilterStateStore, buildQueryFilter } from '@kbn/es-query'; describe('sortFilters', () => { describe('sortFilters()', () => { diff --git a/src/plugins/data/public/query/filter_manager/lib/sort_filters.ts b/src/plugins/data/public/query/filter_manager/lib/sort_filters.ts index c23f116a0eb54..e5ebb80db9b9e 100644 --- a/src/plugins/data/public/query/filter_manager/lib/sort_filters.ts +++ b/src/plugins/data/public/query/filter_manager/lib/sort_filters.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Filter, FilterStateStore } from '../../../../common'; +import { Filter, FilterStateStore } from '@kbn/es-query'; /** * Sort filters according to their store - global filters go first diff --git a/src/plugins/data/public/query/filter_manager/test_helpers/get_filters_array.ts b/src/plugins/data/public/query/filter_manager/test_helpers/get_filters_array.ts index edd730e1e68b5..14fc6cc9ffdbf 100644 --- a/src/plugins/data/public/query/filter_manager/test_helpers/get_filters_array.ts +++ b/src/plugins/data/public/query/filter_manager/test_helpers/get_filters_array.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Filter } from '../../../../common'; +import type { Filter } from '@kbn/es-query'; export function getFiltersArray(): Filter[] { return [ diff --git a/src/plugins/data/public/query/filter_manager/test_helpers/get_stub_filter.ts b/src/plugins/data/public/query/filter_manager/test_helpers/get_stub_filter.ts index e41a9b7d5364f..6a4ba160eb6ab 100644 --- a/src/plugins/data/public/query/filter_manager/test_helpers/get_stub_filter.ts +++ b/src/plugins/data/public/query/filter_manager/test_helpers/get_stub_filter.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Filter, FilterStateStore } from '../../../../common'; +import { Filter, FilterStateStore } from '@kbn/es-query'; export function getFilter( store: FilterStateStore, diff --git a/src/plugins/data/public/query/query_service.ts b/src/plugins/data/public/query/query_service.ts index 07511c8acec19..894db102aa041 100644 --- a/src/plugins/data/public/query/query_service.ts +++ b/src/plugins/data/public/query/query_service.ts @@ -10,7 +10,7 @@ import { share } from 'rxjs/operators'; import { HttpStart, IUiSettingsClient } from '@kbn/core/public'; import { PersistableStateService, VersionedState } from '@kbn/kibana-utils-plugin/common'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; -import { buildEsQuery } from '@kbn/es-query'; +import { buildEsQuery, TimeRange } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/common'; import { FilterManager } from './filter_manager'; import { createAddToQueryLog } from './lib'; @@ -24,7 +24,7 @@ import { import { getQueryState, QueryState } from './query_state'; import type { QueryStringContract } from './query_string'; import { QueryStringManager } from './query_string'; -import { getEsQueryConfig, TimeRange } from '../../common'; +import { getEsQueryConfig } from '../../common'; import { getUiSettings } from '../services'; import { NowProviderInternalContract } from '../now_provider'; import { diff --git a/src/plugins/data/public/query/query_string/query_string_manager.ts b/src/plugins/data/public/query/query_string/query_string_manager.ts index fb9c2b1a734fa..f8d9025ad0db4 100644 --- a/src/plugins/data/public/query/query_string/query_string_manager.ts +++ b/src/plugins/data/public/query/query_string/query_string_manager.ts @@ -10,8 +10,9 @@ import { BehaviorSubject } from 'rxjs'; import { skip } from 'rxjs/operators'; import { PublicMethodsOf } from '@kbn/utility-types'; import { CoreStart } from '@kbn/core/public'; +import type { Query } from '@kbn/es-query'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; -import { KIBANA_USER_QUERY_LANGUAGE_KEY, Query, UI_SETTINGS } from '../../../common'; +import { KIBANA_USER_QUERY_LANGUAGE_KEY, UI_SETTINGS } from '../../../common'; export class QueryStringManager { private query$: BehaviorSubject; diff --git a/src/plugins/data/public/query/saved_query/types.ts b/src/plugins/data/public/query/saved_query/types.ts index 0f1763433e72a..eac7bd3aa30b1 100644 --- a/src/plugins/data/public/query/saved_query/types.ts +++ b/src/plugins/data/public/query/saved_query/types.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -import { RefreshInterval, TimeRange, Query, Filter } from '../..'; +import type { TimeRange, Query, Filter } from '@kbn/es-query'; +import { RefreshInterval } from '../..'; export type SavedQueryTimeFilter = TimeRange & { refreshInterval: RefreshInterval; diff --git a/src/plugins/data/public/query/state_sync/connect_to_query_state.ts b/src/plugins/data/public/query/state_sync/connect_to_query_state.ts index a625dff04b0a3..41e386ac370d2 100644 --- a/src/plugins/data/public/query/state_sync/connect_to_query_state.ts +++ b/src/plugins/data/public/query/state_sync/connect_to_query_state.ts @@ -9,12 +9,11 @@ import { Subscription } from 'rxjs'; import { filter, map } from 'rxjs/operators'; import _ from 'lodash'; -import { COMPARE_ALL_OPTIONS, compareFilters } from '@kbn/es-query'; +import { COMPARE_ALL_OPTIONS, compareFilters, FilterStateStore } from '@kbn/es-query'; import { BaseStateContainer } from '@kbn/kibana-utils-plugin/public'; import { QuerySetup, QueryStart } from '../query_service'; import { QueryState } from '../query_state'; import { QueryStateChange } from './types'; -import { FilterStateStore } from '../../../common'; import { validateTimeRange } from '../timefilter'; /** diff --git a/src/plugins/data/public/query/state_sync/sync_state_with_url.test.ts b/src/plugins/data/public/query/state_sync/sync_state_with_url.test.ts index feb9fc5238ab6..10cbe1bd25c5b 100644 --- a/src/plugins/data/public/query/state_sync/sync_state_with_url.test.ts +++ b/src/plugins/data/public/query/state_sync/sync_state_with_url.test.ts @@ -8,9 +8,10 @@ import { Subscription } from 'rxjs'; import { createBrowserHistory, History } from 'history'; +import { Filter, FilterStateStore } from '@kbn/es-query'; import { FilterManager } from '../filter_manager'; import { getFilter } from '../filter_manager/test_helpers/get_stub_filter'; -import { Filter, FilterStateStore, UI_SETTINGS } from '../../../common'; +import { UI_SETTINGS } from '../../../common'; import { coreMock } from '@kbn/core/public/mocks'; import { createKbnUrlStateStorage, diff --git a/src/plugins/data/public/query/state_sync/sync_state_with_url.ts b/src/plugins/data/public/query/state_sync/sync_state_with_url.ts index 030cc1f91d4fe..c4bee3b66fe51 100644 --- a/src/plugins/data/public/query/state_sync/sync_state_with_url.ts +++ b/src/plugins/data/public/query/state_sync/sync_state_with_url.ts @@ -11,9 +11,9 @@ import { IKbnUrlStateStorage, syncState, } from '@kbn/kibana-utils-plugin/public'; +import { FilterStateStore } from '@kbn/es-query'; import { QuerySetup, QueryStart } from '../query_service'; import { connectToQueryState } from './connect_to_query_state'; -import { FilterStateStore } from '../../../common'; import { GlobalQueryStateFromUrl } from './types'; const GLOBAL_STATE_STORAGE_KEY = '_g'; diff --git a/src/plugins/data/public/query/timefilter/lib/validate_timerange.ts b/src/plugins/data/public/query/timefilter/lib/validate_timerange.ts index e9eb97d004c91..47ea6c338ad94 100644 --- a/src/plugins/data/public/query/timefilter/lib/validate_timerange.ts +++ b/src/plugins/data/public/query/timefilter/lib/validate_timerange.ts @@ -7,7 +7,7 @@ */ import dateMath from '@kbn/datemath'; -import { TimeRange } from '../../../../common'; +import { TimeRange } from '@kbn/es-query'; export function validateTimeRange(time?: TimeRange): boolean { if (!time) return false; diff --git a/src/plugins/data/public/query/timefilter/time_history.ts b/src/plugins/data/public/query/timefilter/time_history.ts index 548973ab815d2..2b84039238b13 100644 --- a/src/plugins/data/public/query/timefilter/time_history.ts +++ b/src/plugins/data/public/query/timefilter/time_history.ts @@ -9,8 +9,8 @@ import moment from 'moment'; import { PublicMethodsOf } from '@kbn/utility-types'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; +import { TimeRange } from '@kbn/es-query'; import { PersistedLog } from '../persisted_log'; -import { TimeRange } from '../../../common'; export class TimeHistory { private history: PersistedLog; diff --git a/src/plugins/data/public/query/timefilter/timefilter.test.ts b/src/plugins/data/public/query/timefilter/timefilter.test.ts index c7cd5318730af..0152076c7b8a6 100644 --- a/src/plugins/data/public/query/timefilter/timefilter.test.ts +++ b/src/plugins/data/public/query/timefilter/timefilter.test.ts @@ -10,9 +10,10 @@ jest.useFakeTimers(); import sinon from 'sinon'; import moment from 'moment'; +import { TimeRange } from '@kbn/es-query'; import { AutoRefreshDoneFn, Timefilter } from './timefilter'; import { Subscription } from 'rxjs'; -import { TimeRange, RefreshInterval } from '../../../common'; +import { RefreshInterval } from '../../../common'; import { createNowProviderMock } from '../../now_provider/mocks'; import { timefilterServiceMock } from './timefilter_service.mock'; diff --git a/src/plugins/data/public/query/timefilter/timefilter.ts b/src/plugins/data/public/query/timefilter/timefilter.ts index c0fddfb3bd608..11c44bd296640 100644 --- a/src/plugins/data/public/query/timefilter/timefilter.ts +++ b/src/plugins/data/public/query/timefilter/timefilter.ts @@ -10,6 +10,7 @@ import _ from 'lodash'; import { Subject, BehaviorSubject } from 'rxjs'; import moment from 'moment'; import { PublicMethodsOf } from '@kbn/utility-types'; +import { TimeRange } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/common'; import { areRefreshIntervalsDifferent, areTimeRangesDifferent } from './lib/diff_time_picker_vals'; import type { TimefilterConfig, InputTimeRange, TimeRangeBounds } from './types'; @@ -20,7 +21,6 @@ import { getTime, getRelativeTime, RefreshInterval, - TimeRange, } from '../../../common'; import { TimeHistoryContract } from './time_history'; import { createAutoRefreshLoop, AutoRefreshDoneFn } from './lib/auto_refresh_loop'; diff --git a/src/plugins/data/public/query/timefilter/timefilter_service.mock.ts b/src/plugins/data/public/query/timefilter/timefilter_service.mock.ts index 6a16924a0f20b..523b03d6f06c1 100644 --- a/src/plugins/data/public/query/timefilter/timefilter_service.mock.ts +++ b/src/plugins/data/public/query/timefilter/timefilter_service.mock.ts @@ -7,9 +7,9 @@ */ import type { PublicMethodsOf } from '@kbn/utility-types'; +import type { TimeRange } from '@kbn/es-query'; import { TimefilterService, TimeHistoryContract, TimefilterContract } from '.'; import { Observable } from 'rxjs'; -import { TimeRange } from '../../../common'; export type TimefilterServiceClientContract = PublicMethodsOf; diff --git a/src/plugins/data/public/query/timefilter/types.ts b/src/plugins/data/public/query/timefilter/types.ts index 3c35ae2d79ae5..1392022768fa7 100644 --- a/src/plugins/data/public/query/timefilter/types.ts +++ b/src/plugins/data/public/query/timefilter/types.ts @@ -8,7 +8,8 @@ import { Moment } from 'moment'; -import { TimeRange, RefreshInterval } from '../../../common'; +import { TimeRange } from '@kbn/es-query'; +import { RefreshInterval } from '../../../common'; export interface TimefilterConfig { timeDefaults: TimeRange; diff --git a/src/plugins/data/server/deprecated.ts b/src/plugins/data/server/deprecated.ts deleted file mode 100644 index ac1fdf4d8abf5..0000000000000 --- a/src/plugins/data/server/deprecated.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { - buildQueryFilter, - buildCustomFilter, - buildEmptyFilter, - buildExistsFilter, - buildFilter, - buildPhraseFilter, - buildPhrasesFilter, - buildRangeFilter, - isFilterDisabled, - fromKueryExpression, - toElasticsearchQuery, - buildEsQuery, - buildQueryFromFilters, -} from '../common'; -/* - * Filter helper namespace: - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esFilters = { - buildQueryFilter, - buildCustomFilter, - buildEmptyFilter, - buildExistsFilter, - buildFilter, - buildPhraseFilter, - buildPhrasesFilter, - buildRangeFilter, - isFilterDisabled, -}; - -/* - * esQuery and esKuery: - */ - -import { getEsQueryConfig } from '../common'; - -/* - * Filter helper namespace - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esKuery = { - fromKueryExpression, - toElasticsearchQuery, -}; - -/* - * Filter helper namespace - * @deprecated Import helpers from the "@kbn/es-query" package directly instead. - * @removeBy 8.1 - */ -export const esQuery = { - buildQueryFromFilters, - getEsQueryConfig, - buildEsQuery, -}; - -export type { Filter, Query, EsQueryConfig, KueryNode } from '../common'; diff --git a/src/plugins/data/server/index.ts b/src/plugins/data/server/index.ts index 21c4fd42831c1..52e480665f00f 100644 --- a/src/plugins/data/server/index.ts +++ b/src/plugins/data/server/index.ts @@ -6,14 +6,10 @@ * Side Public License, v 1. */ -// TODO: https://github.com/elastic/kibana/issues/109904 -/* eslint-disable @kbn/eslint/no_export_all */ - import { PluginConfigDescriptor, PluginInitializerContext } from '@kbn/core/server'; import { ConfigSchema, configSchema } from '../config'; import { DataServerPlugin, DataPluginSetup, DataPluginStart } from './plugin'; -export * from './deprecated'; export { getEsQueryConfig, DEFAULT_QUERY_LANGUAGE } from '../common'; export { getRequestAbortedSignal } from './lib'; @@ -93,7 +89,6 @@ export const search = { * @public */ -export type { TimeRange } from '../common'; export { getTime, parseInterval } from '../common'; /** diff --git a/src/plugins/data/server/query/route_handler_context.test.ts b/src/plugins/data/server/query/route_handler_context.test.ts index c0db432ce3fd9..33d4597ecff0b 100644 --- a/src/plugins/data/server/query/route_handler_context.test.ts +++ b/src/plugins/data/server/query/route_handler_context.test.ts @@ -7,7 +7,8 @@ */ import { coreMock } from '@kbn/core/server/mocks'; -import { DATA_VIEW_SAVED_OBJECT_TYPE, FilterStateStore } from '../../common'; +import { FilterStateStore } from '@kbn/es-query'; +import { DATA_VIEW_SAVED_OBJECT_TYPE } from '../../common'; import type { SavedObject, SavedQueryAttributes } from '../../common'; import { registerSavedQueryRouteHandlerContext } from './route_handler_context'; import { SavedObjectsFindResponse, SavedObjectsUpdateResponse } from '@kbn/core/server'; diff --git a/src/plugins/data/server/search/session/check_non_persisted_sessions.ts b/src/plugins/data/server/search/session/check_non_persisted_sessions.ts index 86f377db57d23..f6314611afdbc 100644 --- a/src/plugins/data/server/search/session/check_non_persisted_sessions.ts +++ b/src/plugins/data/server/search/session/check_non_persisted_sessions.ts @@ -10,13 +10,12 @@ import { SavedObjectsFindResult } from '@kbn/core/server'; import moment from 'moment'; import { EMPTY } from 'rxjs'; import { catchError, concatMap } from 'rxjs/operators'; +import { nodeBuilder, KueryNode } from '@kbn/es-query'; import { - nodeBuilder, ENHANCED_ES_SEARCH_STRATEGY, SEARCH_SESSION_TYPE, SearchSessionSavedObjectAttributes, SearchSessionStatus, - KueryNode, } from '../../../common'; import { checkSearchSessionsByPage, getSearchSessionsPage$ } from './get_search_session_page'; import { CheckSearchSessionsDeps, SearchStatus } from './types'; diff --git a/src/plugins/data/server/search/session/check_persisted_sessions.ts b/src/plugins/data/server/search/session/check_persisted_sessions.ts index 915d8af3fe80f..ace921a56a052 100644 --- a/src/plugins/data/server/search/session/check_persisted_sessions.ts +++ b/src/plugins/data/server/search/session/check_persisted_sessions.ts @@ -8,7 +8,8 @@ import { EMPTY, Observable } from 'rxjs'; import { catchError, concatMap } from 'rxjs/operators'; -import { nodeBuilder, SEARCH_SESSION_TYPE, SearchSessionStatus, KueryNode } from '../../../common'; +import { nodeBuilder, KueryNode } from '@kbn/es-query'; +import { SEARCH_SESSION_TYPE, SearchSessionStatus } from '../../../common'; import { checkSearchSessionsByPage, getSearchSessionsPage$ } from './get_search_session_page'; import { CheckSearchSessionsDeps, SearchSessionsResponse } from './types'; import { bulkUpdateSessions, getAllSessionsStatusUpdates } from './update_session_status'; diff --git a/src/plugins/data/server/search/session/expire_persisted_sessions.ts b/src/plugins/data/server/search/session/expire_persisted_sessions.ts index 77ae9d3f5a155..1c7ad8ff3e346 100644 --- a/src/plugins/data/server/search/session/expire_persisted_sessions.ts +++ b/src/plugins/data/server/search/session/expire_persisted_sessions.ts @@ -8,7 +8,8 @@ import { EMPTY, Observable } from 'rxjs'; import { catchError, concatMap } from 'rxjs/operators'; -import { nodeBuilder, SEARCH_SESSION_TYPE, SearchSessionStatus, KueryNode } from '../../../common'; +import { nodeBuilder, KueryNode } from '@kbn/es-query'; +import { SEARCH_SESSION_TYPE, SearchSessionStatus } from '../../../common'; import { checkSearchSessionsByPage, getSearchSessionsPage$ } from './get_search_session_page'; import { CheckSearchSessionsDeps, SearchSessionsResponse } from './types'; import { bulkUpdateSessions, getAllSessionsStatusUpdates } from './update_session_status'; diff --git a/src/plugins/data/server/search/session/get_search_session_page.ts b/src/plugins/data/server/search/session/get_search_session_page.ts index 30dc72eaa6813..d98d513c9e73f 100644 --- a/src/plugins/data/server/search/session/get_search_session_page.ts +++ b/src/plugins/data/server/search/session/get_search_session_page.ts @@ -9,11 +9,8 @@ import { SavedObjectsClientContract, Logger } from '@kbn/core/server'; import { from, Observable, EMPTY } from 'rxjs'; import { concatMap } from 'rxjs/operators'; -import { - SearchSessionSavedObjectAttributes, - SEARCH_SESSION_TYPE, - KueryNode, -} from '../../../common'; +import type { KueryNode } from '@kbn/es-query'; +import { SearchSessionSavedObjectAttributes, SEARCH_SESSION_TYPE } from '../../../common'; import { CheckSearchSessionsDeps, CheckSearchSessionsFn } from './types'; import { SearchSessionsConfigSchema } from '../../../config'; diff --git a/src/plugins/data/server/search/session/session_service.test.ts b/src/plugins/data/server/search/session/session_service.test.ts index 9f780239ea023..c19731d370803 100644 --- a/src/plugins/data/server/search/session/session_service.test.ts +++ b/src/plugins/data/server/search/session/session_service.test.ts @@ -12,6 +12,7 @@ import { SavedObjectsErrorHelpers, } from '@kbn/core/server'; import { savedObjectsClientMock } from '@kbn/core/server/mocks'; +import { nodeBuilder } from '@kbn/es-query'; import { SearchSessionService } from './session_service'; import { createRequestHash } from './utils'; import moment from 'moment'; @@ -19,7 +20,7 @@ import { coreMock } from '@kbn/core/server/mocks'; import { ConfigSchema } from '../../../config'; import { taskManagerMock } from '@kbn/task-manager-plugin/server/mocks'; import type { AuthenticatedUser } from '@kbn/security-plugin/common/model'; -import { nodeBuilder, SEARCH_SESSION_TYPE, SearchSessionStatus } from '../../../common'; +import { SEARCH_SESSION_TYPE, SearchSessionStatus } from '../../../common'; import type { TaskManagerStartContract } from '@kbn/task-manager-plugin/server'; const MAX_UPDATE_RETRIES = 3; diff --git a/src/plugins/data/server/search/session/types.ts b/src/plugins/data/server/search/session/types.ts index e564a8cef9e79..1571136891106 100644 --- a/src/plugins/data/server/search/session/types.ts +++ b/src/plugins/data/server/search/session/types.ts @@ -22,7 +22,8 @@ import type { TaskManagerSetupContract, TaskManagerStartContract, } from '@kbn/task-manager-plugin/server'; -import { KueryNode, SearchSessionSavedObjectAttributes } from '../../../common'; +import { KueryNode } from '@kbn/es-query'; +import { SearchSessionSavedObjectAttributes } from '../../../common'; import { IKibanaSearchRequest, ISearchOptions } from '../../../common/search'; import { SearchSessionsConfigSchema, ConfigSchema } from '../../../config'; diff --git a/src/plugins/discover/public/application/context/context_app.tsx b/src/plugins/discover/public/application/context/context_app.tsx index 482598ea40f38..b56364781206b 100644 --- a/src/plugins/discover/public/application/context/context_app.tsx +++ b/src/plugins/discover/public/application/context/context_app.tsx @@ -118,7 +118,7 @@ export const ContextApp = ({ indexPattern, anchorId }: ContextAppProps) => { const addFilter = useCallback( async (field: DataViewField | string, values: unknown, operation: string) => { - const newFilters = generateFilters(filterManager, field, values, operation, indexPattern.id!); + const newFilters = generateFilters(filterManager, field, values, operation, indexPattern); filterManager.addFilters(newFilters); if (indexPatterns) { const fieldName = typeof field === 'string' ? field : field.name; diff --git a/src/plugins/discover/public/application/context/services/context.predecessors.test.ts b/src/plugins/discover/public/application/context/services/context.predecessors.test.ts index 3b04e7801da4d..d9b55303ad507 100644 --- a/src/plugins/discover/public/application/context/services/context.predecessors.test.ts +++ b/src/plugins/discover/public/application/context/services/context.predecessors.test.ts @@ -10,9 +10,10 @@ import moment from 'moment'; import { get, last } from 'lodash'; import type { DataView } from '@kbn/data-views-plugin/public'; import { SortDirection } from '@kbn/data-plugin/public'; +import { Query } from '@kbn/es-query'; import { createContextSearchSourceStub } from './_stubs'; import { fetchSurroundingDocs, SurrDocType } from './context'; -import { DataPublicPluginStart, Query } from '@kbn/data-plugin/public'; +import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { EsHitRecord, EsHitRecordList } from '../../types'; const MS_PER_DAY = 24 * 60 * 60 * 1000; diff --git a/src/plugins/discover/public/application/context/services/context.successors.test.ts b/src/plugins/discover/public/application/context/services/context.successors.test.ts index 08e5013f1ed80..c9f819c6497d9 100644 --- a/src/plugins/discover/public/application/context/services/context.successors.test.ts +++ b/src/plugins/discover/public/application/context/services/context.successors.test.ts @@ -11,7 +11,8 @@ import { get, last } from 'lodash'; import { SortDirection } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { createContextSearchSourceStub } from './_stubs'; -import { DataPublicPluginStart, Query } from '@kbn/data-plugin/public'; +import { DataPublicPluginStart } from '@kbn/data-plugin/public'; +import { Query } from '@kbn/es-query'; import { fetchSurroundingDocs, SurrDocType } from './context'; import { EsHitRecord, EsHitRecordList } from '../../types'; diff --git a/src/plugins/discover/public/application/main/components/field_stats_table/field_stats_table.tsx b/src/plugins/discover/public/application/main/components/field_stats_table/field_stats_table.tsx index 7838190608a97..be6e2dd54e9d9 100644 --- a/src/plugins/discover/public/application/main/components/field_stats_table/field_stats_table.tsx +++ b/src/plugins/discover/public/application/main/components/field_stats_table/field_stats_table.tsx @@ -7,9 +7,8 @@ */ import React, { useEffect, useMemo, useRef, useState } from 'react'; -import type { Filter } from '@kbn/es-query'; +import type { Filter, Query } from '@kbn/es-query'; import { METRIC_TYPE, UiCounterMetricType } from '@kbn/analytics'; -import type { Query } from '@kbn/data-plugin/public'; import type { DataViewField, DataView } from '@kbn/data-views-plugin/public'; import { EmbeddableInput, diff --git a/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx b/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx index d68414f6e8478..c9032001947ea 100644 --- a/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx +++ b/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx @@ -172,13 +172,7 @@ export function DiscoverLayout({ (field: DataViewField | string, values: string, operation: '+' | '-') => { const fieldName = typeof field === 'string' ? field : field.name; popularizeField(indexPattern, fieldName, indexPatterns, capabilities); - const newFilters = generateFilters( - filterManager, - field, - values, - operation, - String(indexPattern.id) - ); + const newFilters = generateFilters(filterManager, field, values, operation, indexPattern); if (trackUiMetric) { trackUiMetric(METRIC_TYPE.CLICK, 'filter_added'); } @@ -251,7 +245,6 @@ export function DiscoverLayout({ resetSavedSearch={resetSavedSearch} onChangeIndexPattern={onChangeIndexPattern} onEditRuntimeField={onEditRuntimeField} - useNewFieldsApi={useNewFieldsApi} /> ; /** - * Callback to edit a runtime field from index pattern + * Callback to edit a field from data view * @param fieldName name of the field to edit */ onEditField?: (fieldName: string) => void; /** - * Callback to delete a runtime field from index pattern + * Callback to delete a runtime field from data view * @param fieldName name of the field to delete */ onDeleteField?: (fieldName: string) => void; diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx index 5a553dc67596a..34cfde26ff32c 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx @@ -9,6 +9,7 @@ import { cloneDeep, each } from 'lodash'; import { ReactWrapper } from 'enzyme'; import { findTestSubject } from '@elastic/eui/lib/test'; +import { Action } from '@kbn/ui-actions-plugin/public'; // @ts-expect-error import realHits from '../../../../__fixtures__/real_hits'; @@ -29,6 +30,16 @@ import { BehaviorSubject } from 'rxjs'; import { FetchStatus } from '../../../types'; import { AvailableFields$ } from '../../hooks/use_saved_search'; +const mockGetActions = jest.fn>>, [string, { fieldName: string }]>( + () => Promise.resolve([]) +); + +jest.mock('../../../../kibana_services', () => ({ + getUiActions: () => ({ + getTriggerCompatibleActions: mockGetActions, + }), +})); + function getCompProps(): DiscoverSidebarProps { const indexPattern = stubLogstashIndexPattern; const hits = each(cloneDeep(realHits), (hit) => @@ -73,6 +84,7 @@ function getCompProps(): DiscoverSidebarProps { createNewDataView: jest.fn(), onDataViewCreated: jest.fn(), availableFields$, + useNewFieldsApi: true, }; } @@ -105,4 +117,80 @@ describe('discover sidebar', function () { findTestSubject(comp, 'fieldToggle-extension').simulate('click'); expect(props.onRemoveField).toHaveBeenCalledWith('extension'); }); + + it('should render "Add a field" button', () => { + const addFieldButton = findTestSubject(comp, 'indexPattern-add-field_btn'); + expect(addFieldButton.length).toBe(1); + addFieldButton.simulate('click'); + expect(props.editField).toHaveBeenCalledWith(); + }); + + it('should render "Edit field" button', () => { + findTestSubject(comp, 'field-bytes').simulate('click'); + const editFieldButton = findTestSubject(comp, 'discoverFieldListPanelEdit-bytes'); + expect(editFieldButton.length).toBe(1); + editFieldButton.simulate('click'); + expect(props.editField).toHaveBeenCalledWith('bytes'); + }); + + it('should not render Add/Edit field buttons in viewer mode', () => { + const compInViewerMode = mountWithIntl( + + + + ); + const addFieldButton = findTestSubject(compInViewerMode, 'indexPattern-add-field_btn'); + expect(addFieldButton.length).toBe(0); + findTestSubject(comp, 'field-bytes').simulate('click'); + const editFieldButton = findTestSubject(compInViewerMode, 'discoverFieldListPanelEdit-bytes'); + expect(editFieldButton.length).toBe(0); + }); + + it('should render buttons in data view picker correctly', async () => { + const compWithPicker = mountWithIntl( + + + + ); + // open data view picker + findTestSubject(compWithPicker, 'indexPattern-switch-link').simulate('click'); + expect(findTestSubject(compWithPicker, 'changeDataViewPopover').length).toBe(1); + // click "Add a field" + const addFieldButtonInDataViewPicker = findTestSubject( + compWithPicker, + 'indexPattern-add-field' + ); + expect(addFieldButtonInDataViewPicker.length).toBe(1); + addFieldButtonInDataViewPicker.simulate('click'); + expect(props.editField).toHaveBeenCalledWith(); + // click "Create a data view" + const createDataViewButton = findTestSubject(compWithPicker, 'dataview-create-new'); + expect(createDataViewButton.length).toBe(1); + createDataViewButton.simulate('click'); + expect(props.createNewDataView).toHaveBeenCalled(); + }); + + it('should not render buttons in data view picker when in viewer mode', async () => { + const compWithPickerInViewerMode = mountWithIntl( + + + + ); + // open data view picker + findTestSubject(compWithPickerInViewerMode, 'indexPattern-switch-link').simulate('click'); + expect(findTestSubject(compWithPickerInViewerMode, 'changeDataViewPopover').length).toBe(1); + // check that buttons are not present + const addFieldButtonInDataViewPicker = findTestSubject( + compWithPickerInViewerMode, + 'indexPattern-add-field' + ); + expect(addFieldButtonInDataViewPicker.length).toBe(0); + const createDataViewButton = findTestSubject(compWithPickerInViewerMode, 'dataview-create-new'); + expect(createDataViewButton.length).toBe(0); + }); }); diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx index 23ba3e8e0cc71..0141aead76eff 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx @@ -68,9 +68,18 @@ export interface DiscoverSidebarProps extends Omit void | undefined) => void; - editField: (fieldName?: string) => void; + /** + * Handles "Edit field" action + * Buttons will be hidden if not provided + * @param fieldName + */ + editField?: (fieldName?: string) => void; - createNewDataView: () => void; + /** + * Handles "Create a data view action" action + * Buttons will be hidden if not provided + */ + createNewDataView?: () => void; /** * a statistics of the distribution of fields in the given hits @@ -113,9 +122,6 @@ export function DiscoverSidebarComponent({ }: DiscoverSidebarProps) { const { uiSettings, dataViewFieldEditor } = useDiscoverServices(); const [fields, setFields] = useState(null); - - const dataViewFieldEditPermission = dataViewFieldEditor?.userPermissions.editIndexPattern(); - const canEditDataViewField = !!dataViewFieldEditPermission && useNewFieldsApi; const [scrollContainer, setScrollContainer] = useState(null); const [fieldsToRender, setFieldsToRender] = useState(FIELDS_PER_PAGE); const [fieldsPerPage, setFieldsPerPage] = useState(FIELDS_PER_PAGE); @@ -258,7 +264,7 @@ export function DiscoverSidebarComponent({ const deleteField = useMemo( () => - canEditDataViewField && selectedIndexPattern + editField && selectedIndexPattern ? async (fieldName: string) => { const ref = dataViewFieldEditor.openDeleteModal({ ctx: { @@ -279,7 +285,7 @@ export function DiscoverSidebarComponent({ : undefined, [ selectedIndexPattern, - canEditDataViewField, + editField, setFieldEditorRef, closeFlyout, onEditRuntimeField, @@ -396,8 +402,8 @@ export function DiscoverSidebarComponent({ selected={true} trackUiMetric={trackUiMetric} multiFields={multiFields?.get(field.name)} - onEditField={canEditDataViewField ? editField : undefined} - onDeleteField={canEditDataViewField ? deleteField : undefined} + onEditField={editField} + onDeleteField={deleteField} showFieldStats={showFieldStats} /> @@ -456,8 +462,8 @@ export function DiscoverSidebarComponent({ getDetails={getDetailsByField} trackUiMetric={trackUiMetric} multiFields={multiFields?.get(field.name)} - onEditField={canEditDataViewField ? editField : undefined} - onDeleteField={canEditDataViewField ? deleteField : undefined} + onEditField={editField} + onDeleteField={deleteField} showFieldStats={showFieldStats} /> @@ -485,8 +491,8 @@ export function DiscoverSidebarComponent({ getDetails={getDetailsByField} trackUiMetric={trackUiMetric} multiFields={multiFields?.get(field.name)} - onEditField={canEditDataViewField ? editField : undefined} - onDeleteField={canEditDataViewField ? deleteField : undefined} + onEditField={editField} + onDeleteField={deleteField} showFieldStats={showFieldStats} /> @@ -498,18 +504,20 @@ export function DiscoverSidebarComponent({ )}
- - editField()} - size="s" - > - {i18n.translate('discover.fieldChooser.addField.label', { - defaultMessage: 'Add a field', - })} - - + {!!editField && ( + + editField()} + size="s" + > + {i18n.translate('discover.fieldChooser.addField.label', { + defaultMessage: 'Add a field', + })} + + + )} ); diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.test.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.test.tsx index b10285383468c..5dec34da3cfbe 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.test.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.test.tsx @@ -52,6 +52,11 @@ const mockServices = { }, }, docLinks: { links: { discover: { fieldTypeHelp: '' } } }, + dataViewEditor: { + userPermissions: { + editDataView: jest.fn(() => true), + }, + }, } as unknown as DiscoverServices; const mockfieldCounts: Record = {}; @@ -111,6 +116,7 @@ function getCompProps(): DiscoverSidebarResponsiveProps { onEditRuntimeField: jest.fn(), viewMode: VIEW_MODE.DOCUMENT_LEVEL, onDataViewCreated: jest.fn(), + useNewFieldsApi: true, }; } @@ -160,4 +166,31 @@ describe('discover responsive sidebar', function () { expect(findTestSubject(comp, 'fieldList-unpopular').children().length).toBe(4); expect(mockCalcFieldCounts.mock.calls.length).toBe(1); }); + + it('should show "Add a field" button to create a runtime field', () => { + expect(mockServices.dataViewEditor.userPermissions.editDataView).toHaveBeenCalled(); + expect(findTestSubject(comp, 'indexPattern-add-field_btn').length).toBe(1); + }); + + it('should not show "Add a field" button in viewer mode', () => { + const mockedServicesInViewerMode = { + ...mockServices, + dataViewEditor: { + ...mockServices.dataViewEditor, + userPermissions: { + ...mockServices.dataViewEditor.userPermissions, + editDataView: jest.fn(() => false), + }, + }, + }; + const compInViewerMode = mountWithIntl( + + + + ); + expect( + mockedServicesInViewerMode.dataViewEditor.userPermissions.editDataView + ).toHaveBeenCalled(); + expect(findTestSubject(compInViewerMode, 'indexPattern-add-field_btn').length).toBe(0); + }); }); diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx index a9121399c7e04..c6d8d05a23ad8 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import React, { useEffect, useRef, useState, useCallback } from 'react'; +import React, { useEffect, useRef, useState, useCallback, useMemo } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { UiCounterMetricType } from '@kbn/analytics'; @@ -89,7 +89,7 @@ export interface DiscoverSidebarResponsiveProps { /** * Read from the Fields API */ - useNewFieldsApi?: boolean; + useNewFieldsApi: boolean; /** * callback to execute on edit runtime field */ @@ -115,7 +115,7 @@ export interface DiscoverSidebarResponsiveProps { */ export function DiscoverSidebarResponsive(props: DiscoverSidebarResponsiveProps) { const services = useDiscoverServices(); - const { selectedIndexPattern, onEditRuntimeField, useNewFieldsApi, onDataViewCreated } = props; + const { selectedIndexPattern, onEditRuntimeField, onDataViewCreated } = props; const [fieldFilter, setFieldFilter] = useState(getDefaultFieldFilter()); const [isFlyoutVisible, setIsFlyoutVisible] = useState(false); /** @@ -178,6 +178,8 @@ export function DiscoverSidebarResponsive(props: DiscoverSidebarResponsiveProps) const { dataViewFieldEditor, dataViewEditor } = services; const { availableFields$ } = props; + const canEditDataView = Boolean(dataViewEditor?.userPermissions.editDataView()); + useEffect( () => { // For an external embeddable like the Field stats @@ -203,57 +205,56 @@ export function DiscoverSidebarResponsive(props: DiscoverSidebarResponsiveProps) ] ); - const editField = useCallback( - (fieldName?: string) => { - const indexPatternFieldEditPermission = - dataViewFieldEditor?.userPermissions.editIndexPattern(); - const canEditIndexPatternField = !!indexPatternFieldEditPermission && useNewFieldsApi; - if (!canEditIndexPatternField || !selectedIndexPattern) { - return; - } - const ref = dataViewFieldEditor.openEditor({ - ctx: { - dataView: selectedIndexPattern, - }, - fieldName, - onSave: async () => { - onEditRuntimeField(); - }, - }); - if (setFieldEditorRef) { - setFieldEditorRef(ref); - } - if (closeFlyout) { - closeFlyout(); - } - }, + const editField = useMemo( + () => + canEditDataView && selectedIndexPattern + ? (fieldName?: string) => { + const ref = dataViewFieldEditor.openEditor({ + ctx: { + dataView: selectedIndexPattern, + }, + fieldName, + onSave: async () => { + onEditRuntimeField(); + }, + }); + if (setFieldEditorRef) { + setFieldEditorRef(ref); + } + if (closeFlyout) { + closeFlyout(); + } + } + : undefined, [ + canEditDataView, closeFlyout, dataViewFieldEditor, selectedIndexPattern, setFieldEditorRef, onEditRuntimeField, - useNewFieldsApi, ] ); - const createNewDataView = useCallback(() => { - const indexPatternFieldEditPermission = dataViewEditor.userPermissions.editDataView; - if (!indexPatternFieldEditPermission) { - return; - } - const ref = dataViewEditor.openEditor({ - onSave: async (dataView) => { - onDataViewCreated(dataView); - }, - }); - if (setDataViewEditorRef) { - setDataViewEditorRef(ref); - } - if (closeFlyout) { - closeFlyout(); - } - }, [dataViewEditor, setDataViewEditorRef, closeFlyout, onDataViewCreated]); + const createNewDataView = useMemo( + () => + canEditDataView + ? () => { + const ref = dataViewEditor.openEditor({ + onSave: async (dataView) => { + onDataViewCreated(dataView); + }, + }); + if (setDataViewEditorRef) { + setDataViewEditorRef(ref); + } + if (closeFlyout) { + closeFlyout(); + } + } + : undefined, + [canEditDataView, dataViewEditor, setDataViewEditorRef, closeFlyout, onDataViewCreated] + ); if (!selectedIndexPattern) { return null; diff --git a/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.test.tsx b/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.test.tsx index 7b8831f734279..f228c17341ac1 100644 --- a/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.test.tsx +++ b/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.test.tsx @@ -12,7 +12,8 @@ import { indexPatternMock } from '../../../../__mocks__/index_pattern'; import { savedSearchMock } from '../../../../__mocks__/saved_search'; import { DiscoverTopNav, DiscoverTopNavProps } from './discover_topnav'; import { TopNavMenuData } from '@kbn/navigation-plugin/public'; -import { ISearchSource, Query } from '@kbn/data-plugin/public'; +import { ISearchSource } from '@kbn/data-plugin/public'; +import { Query } from '@kbn/es-query'; import { GetStateReturn } from '../../services/discover_state'; import { setHeaderActionMenuMounter } from '../../../../kibana_services'; import { discoverServiceMock } from '../../../../__mocks__/services'; diff --git a/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx b/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx index 265cec27d5344..cb305bf109235 100644 --- a/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx +++ b/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx @@ -7,7 +7,7 @@ */ import React, { useCallback, useMemo, useRef, useEffect } from 'react'; import { useHistory } from 'react-router-dom'; -import { Query, TimeRange } from '@kbn/data-plugin/public'; +import type { Query, TimeRange } from '@kbn/es-query'; import { DataViewType } from '@kbn/data-views-plugin/public'; import { useDiscoverServices } from '../../../../hooks/use_discover_services'; import { DiscoverLayoutProps } from '../layout/types'; @@ -27,7 +27,6 @@ export type DiscoverTopNavProps = Pick< resetSavedSearch: () => void; onChangeIndexPattern: (indexPattern: string) => void; onEditRuntimeField: () => void; - useNewFieldsApi?: boolean; }; export const DiscoverTopNav = ({ @@ -43,7 +42,6 @@ export const DiscoverTopNav = ({ resetSavedSearch, onChangeIndexPattern, onEditRuntimeField, - useNewFieldsApi = false, }: DiscoverTopNavProps) => { const history = useHistory(); const showDatePicker = useMemo( @@ -52,11 +50,9 @@ export const DiscoverTopNav = ({ ); const services = useDiscoverServices(); const { dataViewEditor, navigation, dataViewFieldEditor, data } = services; - const editPermission = useMemo( - () => dataViewFieldEditor.userPermissions.editIndexPattern(), - [dataViewFieldEditor] - ); - const canEditDataViewField = !!editPermission && useNewFieldsApi; + + const canEditDataView = Boolean(dataViewEditor?.userPermissions.editDataView()); + const closeFieldEditor = useRef<() => void | undefined>(); const closeDataViewEditor = useRef<() => void | undefined>(); @@ -87,7 +83,7 @@ export const DiscoverTopNav = ({ const editField = useMemo( () => - canEditDataViewField + canEditDataView ? async (fieldName?: string, uiAction: 'edit' | 'add' = 'edit') => { if (indexPattern?.id) { const indexPatternInstance = await data.dataViews.get(indexPattern.id); @@ -103,33 +99,29 @@ export const DiscoverTopNav = ({ } } : undefined, - [ - canEditDataViewField, - indexPattern?.id, - data.dataViews, - dataViewFieldEditor, - onEditRuntimeField, - ] + [canEditDataView, indexPattern?.id, data.dataViews, dataViewFieldEditor, onEditRuntimeField] ); const addField = useMemo( - () => (canEditDataViewField && editField ? () => editField(undefined, 'add') : undefined), - [editField, canEditDataViewField] + () => (canEditDataView && editField ? () => editField(undefined, 'add') : undefined), + [editField, canEditDataView] ); - const createNewDataView = useCallback(() => { - const indexPatternFieldEditPermission = dataViewEditor.userPermissions.editDataView; - if (!indexPatternFieldEditPermission) { - return; - } - closeDataViewEditor.current = dataViewEditor.openEditor({ - onSave: async (dataView) => { - if (dataView.id) { - onChangeIndexPattern(dataView.id); - } - }, - }); - }, [dataViewEditor, onChangeIndexPattern]); + const createNewDataView = useMemo( + () => + canEditDataView + ? () => { + closeDataViewEditor.current = dataViewEditor.openEditor({ + onSave: async (dataView) => { + if (dataView.id) { + onChangeIndexPattern(dataView.id); + } + }, + }); + } + : undefined, + [canEditDataView, dataViewEditor, onChangeIndexPattern] + ); const topNavMenu = useMemo( () => diff --git a/src/plugins/discover/public/application/main/services/discover_state.ts b/src/plugins/discover/public/application/main/services/discover_state.ts index 81f25e6151c99..bc33b2f1ff09d 100644 --- a/src/plugins/discover/public/application/main/services/discover_state.ts +++ b/src/plugins/discover/public/application/main/services/discover_state.ts @@ -10,7 +10,13 @@ import { isEqual, cloneDeep } from 'lodash'; import { i18n } from '@kbn/i18n'; import { History } from 'history'; import { NotificationsStart, IUiSettingsClient } from '@kbn/core/public'; -import { Filter, FilterStateStore, compareFilters, COMPARE_ALL_OPTIONS } from '@kbn/es-query'; +import { + Filter, + FilterStateStore, + compareFilters, + COMPARE_ALL_OPTIONS, + Query, +} from '@kbn/es-query'; import { createKbnUrlStateStorage, createStateContainer, @@ -24,7 +30,6 @@ import { connectToQueryState, DataPublicPluginStart, FilterManager, - Query, SearchSessionInfoProvider, syncQueryStateWithUrl, } from '@kbn/data-plugin/public'; diff --git a/src/plugins/discover/public/application/view_alert/view_alert_route.tsx b/src/plugins/discover/public/application/view_alert/view_alert_route.tsx index 1e99b318cd55e..2178a99d28251 100644 --- a/src/plugins/discover/public/application/view_alert/view_alert_route.tsx +++ b/src/plugins/discover/public/application/view_alert/view_alert_route.tsx @@ -12,7 +12,7 @@ import { sha256 } from 'js-sha256'; import type { Rule } from '@kbn/alerting-plugin/common'; import { getTime } from '@kbn/data-plugin/common'; import type { DataView } from '@kbn/data-views-plugin/public'; -import type { Filter } from '@kbn/data-plugin/public'; +import type { Filter } from '@kbn/es-query'; import { DiscoverAppLocatorParams } from '../../locator'; import { useDiscoverServices } from '../../hooks/use_discover_services'; import { getAlertUtils, QueryParams, SearchThresholdAlertParams } from './view_alert_utils'; diff --git a/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx b/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx index 0b5d0bc922160..0cd179768df0a 100644 --- a/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx +++ b/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx @@ -7,7 +7,13 @@ */ import { lastValueFrom, Subscription } from 'rxjs'; -import { onlyDisabledFiltersChanged, Filter } from '@kbn/es-query'; +import { + onlyDisabledFiltersChanged, + Filter, + Query, + TimeRange, + FilterStateStore, +} from '@kbn/es-query'; import React from 'react'; import ReactDOM from 'react-dom'; import { i18n } from '@kbn/i18n'; @@ -17,7 +23,7 @@ import type { KibanaExecutionContext } from '@kbn/core/public'; import { Container, Embeddable } from '@kbn/embeddable-plugin/public'; import { Adapters, RequestAdapter } from '@kbn/inspector-plugin/common'; import { APPLY_FILTER_TRIGGER, FilterManager, generateFilters } from '@kbn/data-plugin/public'; -import { ISearchSource, Query, TimeRange, FilterStateStore } from '@kbn/data-plugin/public'; +import { ISearchSource } from '@kbn/data-plugin/public'; import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; import { KibanaContextProvider, KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; @@ -282,7 +288,7 @@ export class SavedSearchEmbeddable field, value, operator, - indexPattern.id! + indexPattern ); filters = filters.map((filter) => ({ ...filter, diff --git a/src/plugins/discover/public/embeddable/search_embeddable_factory.ts b/src/plugins/discover/public/embeddable/search_embeddable_factory.ts index eeb2200b1f7e7..74467a961f96e 100644 --- a/src/plugins/discover/public/embeddable/search_embeddable_factory.ts +++ b/src/plugins/discover/public/embeddable/search_embeddable_factory.ts @@ -14,7 +14,7 @@ import { ErrorEmbeddable, } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { SearchInput, SearchOutput } from './types'; import { SEARCH_EMBEDDABLE_TYPE } from './constants'; diff --git a/src/plugins/discover/public/embeddable/types.ts b/src/plugins/discover/public/embeddable/types.ts index 10f99e301b0ea..5b09082729049 100644 --- a/src/plugins/discover/public/embeddable/types.ts +++ b/src/plugins/discover/public/embeddable/types.ts @@ -12,9 +12,8 @@ import { EmbeddableOutput, IEmbeddable, } from '@kbn/embeddable-plugin/public'; -import type { Filter } from '@kbn/es-query'; +import type { Filter, TimeRange, Query } from '@kbn/es-query'; import { DataView } from '@kbn/data-views-plugin/public'; -import type { TimeRange, Query } from '@kbn/data-plugin/public'; import { SavedSearch } from '../services/saved_searches'; import { SortOrder } from '../components/doc_table/components/table_header/helpers'; diff --git a/src/plugins/discover/public/hooks/use_es_doc_search.test.tsx b/src/plugins/discover/public/hooks/use_es_doc_search.test.tsx index a059ae721ecad..7a482ab086501 100644 --- a/src/plugins/discover/public/hooks/use_es_doc_search.test.tsx +++ b/src/plugins/discover/public/hooks/use_es_doc_search.test.tsx @@ -6,9 +6,9 @@ * Side Public License, v 1. */ -import { renderHook } from '@testing-library/react-hooks'; +import { renderHook, act } from '@testing-library/react-hooks'; import { buildSearchBody, useEsDocSearch } from './use_es_doc_search'; -import { Observable } from 'rxjs'; +import { Subject } from 'rxjs'; import { DataView } from '@kbn/data-views-plugin/public'; import { DocProps } from '../application/doc/components/doc'; import { ElasticRequestState } from '../application/doc/types'; @@ -16,8 +16,7 @@ import { SEARCH_FIELDS_FROM_SOURCE as mockSearchFieldsFromSource } from '../../c import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import React from 'react'; -const mockSearchResult = new Observable(); - +const mockSearchResult = new Subject(); const services = { data: { search: { @@ -171,23 +170,69 @@ describe('Test of helper / hook', () => { `); }); - test('useEsDocSearch', async () => { + test('useEsDocSearch loading', async () => { + const indexPattern = { + getComputedFields: () => [], + }; + const props = { + id: '1', + index: 'index1', + indexPattern, + } as unknown as DocProps; + + const hook = renderHook((p: DocProps) => useEsDocSearch(p), { + initialProps: props, + wrapper: ({ children }) => ( + {children} + ), + }); + + expect(hook.result.current.slice(0, 2)).toEqual([ElasticRequestState.Loading, null]); + }); + + test('useEsDocSearch ignore partial results', async () => { const indexPattern = { getComputedFields: () => [], }; + + const record = { test: 1 }; + const props = { id: '1', index: 'index1', indexPattern, } as unknown as DocProps; - const { result } = renderHook((p: DocProps) => useEsDocSearch(p), { + const hook = renderHook((p: DocProps) => useEsDocSearch(p), { initialProps: props, wrapper: ({ children }) => ( {children} ), }); - expect(result.current.slice(0, 2)).toEqual([ElasticRequestState.Loading, null]); + await act(async () => { + mockSearchResult.next({ + isPartial: true, + isRunning: false, + rawResponse: { + hits: { + hits: [], + }, + }, + }); + mockSearchResult.next({ + isPartial: false, + isRunning: false, + rawResponse: { + hits: { + hits: [record], + }, + }, + }); + mockSearchResult.complete(); + await hook.waitForNextUpdate(); + }); + + expect(hook.result.current.slice(0, 2)).toEqual([ElasticRequestState.Found, record]); }); }); diff --git a/src/plugins/discover/public/hooks/use_es_doc_search.ts b/src/plugins/discover/public/hooks/use_es_doc_search.ts index 27393dca72da3..84e759962de04 100644 --- a/src/plugins/discover/public/hooks/use_es_doc_search.ts +++ b/src/plugins/discover/public/hooks/use_es_doc_search.ts @@ -8,7 +8,7 @@ import { useCallback, useEffect, useMemo, useState } from 'react'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { DataView } from '@kbn/data-views-plugin/public'; import { DocProps } from '../application/doc/components/doc'; import { ElasticRequestState } from '../application/doc/types'; @@ -18,47 +18,6 @@ import { useDiscoverServices } from './use_discover_services'; type RequestBody = Pick; -/** - * helper function to build a query body for Elasticsearch - * https://www.elastic.co/guide/en/elasticsearch/reference/current//query-dsl-ids-query.html - */ -export function buildSearchBody( - id: string, - indexPattern: DataView, - useNewFieldsApi: boolean, - requestAllFields?: boolean -): RequestBody | undefined { - const computedFields = indexPattern.getComputedFields(); - const runtimeFields = computedFields.runtimeFields as estypes.MappingRuntimeFields; - const request: RequestBody = { - body: { - query: { - ids: { - values: [id], - }, - }, - stored_fields: computedFields.storedFields, - script_fields: computedFields.scriptFields, - version: true, - }, - }; - if (!request.body) { - return undefined; - } - if (useNewFieldsApi) { - // @ts-expect-error - request.body.fields = [{ field: '*', include_unmapped: 'true' }]; - request.body.runtime_mappings = runtimeFields ? runtimeFields : {}; - if (requestAllFields) { - request.body._source = true; - } - } else { - request.body._source = true; - } - request.body.fields = [...(request.body?.fields || []), ...(computedFields.docvalueFields || [])]; - return request; -} - /** * Custom react hook for querying a single doc in ElasticSearch */ @@ -75,7 +34,7 @@ export function useEsDocSearch({ const requestData = useCallback(async () => { try { - const { rawResponse } = await firstValueFrom( + const result = await lastValueFrom( data.search.search({ params: { index, @@ -83,6 +42,7 @@ export function useEsDocSearch({ }, }) ); + const rawResponse = result.rawResponse; const hits = rawResponse.hits; @@ -109,3 +69,44 @@ export function useEsDocSearch({ return [status, hit, requestData]; } + +/** + * helper function to build a query body for Elasticsearch + * https://www.elastic.co/guide/en/elasticsearch/reference/current//query-dsl-ids-query.html + */ +export function buildSearchBody( + id: string, + indexPattern: DataView, + useNewFieldsApi: boolean, + requestAllFields?: boolean +): RequestBody | undefined { + const computedFields = indexPattern.getComputedFields(); + const runtimeFields = computedFields.runtimeFields as estypes.MappingRuntimeFields; + const request: RequestBody = { + body: { + query: { + ids: { + values: [id], + }, + }, + stored_fields: computedFields.storedFields, + script_fields: computedFields.scriptFields, + version: true, + }, + }; + if (!request.body) { + return undefined; + } + if (useNewFieldsApi) { + // @ts-expect-error + request.body.fields = [{ field: '*', include_unmapped: 'true' }]; + request.body.runtime_mappings = runtimeFields ? runtimeFields : {}; + if (requestAllFields) { + request.body._source = true; + } + } else { + request.body._source = true; + } + request.body.fields = [...(request.body?.fields || []), ...(computedFields.docvalueFields || [])]; + return request; +} diff --git a/src/plugins/discover/public/locator.test.ts b/src/plugins/discover/public/locator.test.ts index f4b55172e97c1..cc448e9e77d84 100644 --- a/src/plugins/discover/public/locator.test.ts +++ b/src/plugins/discover/public/locator.test.ts @@ -8,7 +8,7 @@ import { hashedItemStore, getStatesFromKbnUrl } from '@kbn/kibana-utils-plugin/public'; import { mockStorage } from '@kbn/kibana-utils-plugin/public/storage/hashed_item_store/mock'; -import { FilterStateStore } from '@kbn/data-plugin/public'; +import { FilterStateStore } from '@kbn/es-query'; import { DiscoverAppLocatorDefinition } from './locator'; import { SerializableRecord } from '@kbn/utility-types'; diff --git a/src/plugins/discover/public/locator.ts b/src/plugins/discover/public/locator.ts index eb4731bd44e64..459c124d46453 100644 --- a/src/plugins/discover/public/locator.ts +++ b/src/plugins/discover/public/locator.ts @@ -7,13 +7,8 @@ */ import type { SerializableRecord } from '@kbn/utility-types'; -import type { Filter } from '@kbn/es-query'; -import type { - TimeRange, - Query, - GlobalQueryStateFromUrl, - RefreshInterval, -} from '@kbn/data-plugin/public'; +import type { Filter, TimeRange, Query } from '@kbn/es-query'; +import type { GlobalQueryStateFromUrl, RefreshInterval } from '@kbn/data-plugin/public'; import type { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/public'; import { setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public'; import type { VIEW_MODE } from './components/view_mode_toggle'; diff --git a/src/plugins/discover/public/utils/migrate_legacy_query.ts b/src/plugins/discover/public/utils/migrate_legacy_query.ts index f9f22c6383c57..2f7c38e7ebe09 100644 --- a/src/plugins/discover/public/utils/migrate_legacy_query.ts +++ b/src/plugins/discover/public/utils/migrate_legacy_query.ts @@ -7,7 +7,7 @@ */ import { has } from 'lodash'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; /** * Creates a standardized query object from old queries that were either strings or pure ES query DSL diff --git a/src/plugins/expressions/common/execution/execution.ts b/src/plugins/expressions/common/execution/execution.ts index 2fda462929ff4..b4ef83389ce28 100644 --- a/src/plugins/expressions/common/execution/execution.ts +++ b/src/plugins/expressions/common/execution/execution.ts @@ -7,6 +7,7 @@ */ import { i18n } from '@kbn/i18n'; +import type { Logger } from '@kbn/logging'; import { isPromise } from '@kbn/std'; import { ObservableLike, UnwrapObservable } from '@kbn/utility-types'; import { keys, last, mapValues, reduce, zipObject } from 'lodash'; @@ -187,7 +188,7 @@ export class Execution< return this.context.inspectorAdapters; } - constructor(public readonly execution: ExecutionParams) { + constructor(public readonly execution: ExecutionParams, private readonly logger?: Logger) { const { executor } = execution; this.contract = new ExecutionContract(this); @@ -331,6 +332,10 @@ export class Execution< }); } + if (fn.deprecated) { + this.logger?.warn(`Function '${fnName}' is deprecated`); + } + if (this.execution.params.debug) { link.debug = { args: {}, @@ -448,12 +453,16 @@ export class Execution< } validate(value: Type, argDef: ExpressionFunctionParameter): void { - if (argDef.strict && argDef.options?.length && !argDef.options.includes(value)) { - throw new Error( - `Value '${value}' is not among the allowed options for argument '${ - argDef.name - }': '${argDef.options.join("', '")}'` - ); + if (argDef.options?.length && !argDef.options.includes(value)) { + const message = `Value '${value}' is not among the allowed options for argument '${ + argDef.name + }': '${argDef.options.join("', '")}'`; + + if (argDef.strict) { + throw new Error(message); + } + + this.logger?.warn(message); } } @@ -474,6 +483,9 @@ export class Execution< if (!argDef) { throw new Error(`Unknown argument '${argName}' passed to function '${fnDef.name}'`); } + if (argDef.deprecated && !acc[argDef.name]) { + this.logger?.warn(`Argument '${argName}' is deprecated in function '${fnDef.name}'`); + } acc[argDef.name] = (acc[argDef.name] || []).concat(argAst); return acc; }, diff --git a/src/plugins/expressions/common/executor/executor.execution.test.ts b/src/plugins/expressions/common/executor/executor.execution.test.ts index ad7e6e6a014c1..ea906881e9738 100644 --- a/src/plugins/expressions/common/executor/executor.execution.test.ts +++ b/src/plugins/expressions/common/executor/executor.execution.test.ts @@ -26,7 +26,8 @@ describe('Executor mocked execution tests', () => { executor.createExecution('foo bar="baz"'); expect(Execution).toHaveBeenCalledWith( - expect.objectContaining({ expression: 'foo bar="baz"' }) + expect.objectContaining({ expression: 'foo bar="baz"' }), + undefined ); }); }); @@ -38,7 +39,8 @@ describe('Executor mocked execution tests', () => { executor.createExecution(ast); expect(Execution).toHaveBeenCalledWith( - expect.not.objectContaining({ expression: expect.anything() }) + expect.not.objectContaining({ expression: expect.anything() }), + undefined ); }); }); diff --git a/src/plugins/expressions/common/executor/executor.test.ts b/src/plugins/expressions/common/executor/executor.test.ts index ea7116a5307ba..6f9dae491e5b2 100644 --- a/src/plugins/expressions/common/executor/executor.test.ts +++ b/src/plugins/expressions/common/executor/executor.test.ts @@ -111,7 +111,7 @@ describe('Executor', () => { test('Execution inherits context from Executor', () => { const foo = {}; - const executor = new Executor({ context: { foo }, functions: {}, types: {} }); + const executor = new Executor(undefined, { context: { foo }, functions: {}, types: {} }); const execution = executor.createExecution('foo bar="baz"'); expect(execution.context).toHaveProperty('foo', foo); diff --git a/src/plugins/expressions/common/executor/executor.ts b/src/plugins/expressions/common/executor/executor.ts index 4071f8f7f003f..e8d01b15fd81d 100644 --- a/src/plugins/expressions/common/executor/executor.ts +++ b/src/plugins/expressions/common/executor/executor.ts @@ -10,6 +10,7 @@ import { cloneDeep, mapValues } from 'lodash'; import { Observable } from 'rxjs'; +import type { Logger } from '@kbn/logging'; import type { SerializableRecord } from '@kbn/utility-types'; import { SavedObjectReference } from '@kbn/core/types'; import { @@ -87,9 +88,10 @@ export class Executor = Record { static createWithDefaults = Record>( + logger?: Logger, state?: ExecutorState ): Executor { - const executor = new Executor(state); + const executor = new Executor(logger, state); for (const type of typeSpecs) executor.registerType(type); return executor; @@ -107,34 +109,14 @@ export class Executor = Record; - - constructor(state?: ExecutorState) { + constructor(private readonly logger?: Logger, state?: ExecutorState) { this.functions = new FunctionsRegistry(this as Executor); this.types = new TypesRegistry(this as Executor); this.container = createExecutorContainer(state); } public get state(): ExecutorState { - const parent = this.parent?.state; - const state = this.container.get(); - - return { - ...(parent ?? {}), - ...state, - types: { - ...(parent?.types ?? {}), - ...state.types, - }, - functions: { - ...(parent?.functions ?? {}), - ...state.functions, - }, - context: { - ...(parent?.context ?? {}), - ...state.context, - }, - }; + return this.container.get(); } public registerFunction( @@ -148,7 +130,10 @@ export class Executor = Record { @@ -170,21 +155,15 @@ export class Executor = Record { - return { - ...(this.parent?.getTypes() ?? {}), - ...this.container.get().types, - }; + return this.container.get().types; } public get context(): Record { - return { - ...(this.parent?.context ?? {}), - ...this.container.selectors.getContext(), - }; + return this.container.selectors.getContext(); } /** @@ -215,7 +194,7 @@ export class Executor = Record(executionParams); + const execution = new Execution(executionParams, this.logger); return execution; } @@ -369,11 +348,4 @@ export class Executor = Record { - const fork = new Executor(); - fork.parent = this; - - return fork; - } } diff --git a/src/plugins/expressions/common/service/expressions_services.ts b/src/plugins/expressions/common/service/expressions_services.ts index d4bac702bd6e0..d2824a7894642 100644 --- a/src/plugins/expressions/common/service/expressions_services.ts +++ b/src/plugins/expressions/common/service/expressions_services.ts @@ -7,6 +7,7 @@ */ import { Observable } from 'rxjs'; +import type { Logger } from '@kbn/logging'; import type { SerializableRecord } from '@kbn/utility-types'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths import type { KibanaRequest } from '@kbn/core/server'; @@ -270,6 +271,7 @@ export interface ExpressionsServiceStart { export interface ExpressionServiceParams { executor?: Executor; + logger?: Logger; renderers?: ExpressionRendererRegistry; } @@ -306,7 +308,8 @@ export class ExpressionsService public readonly renderers: ExpressionRendererRegistry; constructor({ - executor = Executor.createWithDefaults(), + logger, + executor = Executor.createWithDefaults(logger), renderers = new ExpressionRendererRegistry(), }: ExpressionServiceParams = {}) { this.executor = executor; diff --git a/src/plugins/expressions/public/plugin.ts b/src/plugins/expressions/public/plugin.ts index 338783c0a5ba4..6b16a9e91d6c8 100644 --- a/src/plugins/expressions/public/plugin.ts +++ b/src/plugins/expressions/public/plugin.ts @@ -35,7 +35,18 @@ export interface ExpressionsStart extends ExpressionsServiceStart { } export class ExpressionsPublicPlugin implements Plugin { - private readonly expressions: ExpressionsService = new ExpressionsService(); + private static logger = { + ...console, + // eslint-disable-next-line no-console + fatal: console.error, + get() { + return this; + }, + }; + + private readonly expressions: ExpressionsService = new ExpressionsService({ + logger: ExpressionsPublicPlugin.logger, + }); constructor(initializerContext: PluginInitializerContext) {} diff --git a/src/plugins/expressions/server/plugin.ts b/src/plugins/expressions/server/plugin.ts index 750d61ec5eb03..2672e316b596c 100644 --- a/src/plugins/expressions/server/plugin.ts +++ b/src/plugins/expressions/server/plugin.ts @@ -17,9 +17,13 @@ export type ExpressionsServerStart = ExpressionsServiceStart; export class ExpressionsServerPlugin implements Plugin { - readonly expressions: ExpressionsService = new ExpressionsService(); + readonly expressions: ExpressionsService; - constructor(initializerContext: PluginInitializerContext) {} + constructor(context: PluginInitializerContext) { + this.expressions = new ExpressionsService({ + logger: context.logger.get('expressions'), + }); + } public setup(core: CoreSetup): ExpressionsServerSetup { const setup = this.expressions.setup(pick(core, 'getStartServices')); diff --git a/src/plugins/presentation_util/public/components/solution_toolbar/items/index.ts b/src/plugins/presentation_util/public/components/solution_toolbar/items/index.ts index 32972e4d2628d..cc6367bc3fcd5 100644 --- a/src/plugins/presentation_util/public/components/solution_toolbar/items/index.ts +++ b/src/plugins/presentation_util/public/components/solution_toolbar/items/index.ts @@ -10,7 +10,7 @@ export { SolutionToolbarButton } from './button'; export { SolutionToolbarPopover } from './popover'; export { AddFromLibraryButton } from './add_from_library'; export type { QuickButtonProps } from './quick_group'; -/** @deprecated use `IconButtonGroup` from `@kbn/shared-ux-components */ +/** @deprecated use `IconButtonGroup` from `@kbn/shared-ux-button-toolbar` */ export { QuickButtonGroup } from './quick_group'; export { PrimaryActionButton } from './primary_button'; export { PrimaryActionPopover } from './primary_popover'; diff --git a/src/plugins/presentation_util/public/index.ts b/src/plugins/presentation_util/public/index.ts index 35b13d248d8c8..cb1cbb60d4412 100644 --- a/src/plugins/presentation_util/public/index.ts +++ b/src/plugins/presentation_util/public/index.ts @@ -54,7 +54,7 @@ export { AddFromLibraryButton, PrimaryActionButton, PrimaryActionPopover, - /** @deprecated QuickButtonGroup - use `IconButtonGroup` from `@kbn/shared-ux-components */ + /** @deprecated QuickButtonGroup - use `IconButtonGroup` from `@kbn/shared-ux-button-toolbar` */ QuickButtonGroup, SolutionToolbar, SolutionToolbarButton, diff --git a/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts b/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts index 3dd8d658b3906..e3b2122398632 100644 --- a/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts +++ b/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts @@ -7,7 +7,7 @@ */ import { Embeddable, IContainer, ContainerInput } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { TimeRangeInput } from './custom_time_range_action'; interface ContainerTimeRangeInput extends ContainerInput { diff --git a/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx b/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx index df22733a4d494..6d84e52f5344c 100644 --- a/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx +++ b/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx @@ -14,8 +14,8 @@ import { EmbeddableInput, EmbeddableOutput, } from '@kbn/embeddable-plugin/public'; +import { TimeRange } from '@kbn/es-query'; import { Action, IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; import { OpenModal, CommonlyUsedRange } from './types'; export const CUSTOM_TIME_RANGE = 'CUSTOM_TIME_RANGE'; diff --git a/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx b/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx index 4f5b5b6cb6be8..ffed76649d8ca 100644 --- a/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx +++ b/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx @@ -11,7 +11,7 @@ import { renderToString } from 'react-dom/server'; import { PrettyDuration } from '@elastic/eui'; import { IEmbeddable, Embeddable, EmbeddableInput } from '@kbn/embeddable-plugin/public'; import { Action, IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { doesInheritTimeRange } from './does_inherit_time_range'; import { OpenModal, CommonlyUsedRange } from './types'; diff --git a/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx b/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx index 57b8a433d42ef..0bcd36741d8c6 100644 --- a/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx +++ b/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx @@ -21,8 +21,8 @@ import { EuiFlexItem, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import type { TimeRange } from '@kbn/es-query'; import { Embeddable, IContainer, ContainerInput } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; import { TimeRangeInput } from './custom_time_range_action'; import { doesInheritTimeRange } from './does_inherit_time_range'; import { CommonlyUsedRange } from './types'; diff --git a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts index f04f89e19e039..0e6044ba9291e 100644 --- a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts +++ b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts @@ -12,7 +12,7 @@ import { ContainerOutput, EmbeddableStart, } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; /** * interfaces are not allowed to specify a sub-set of the required types until diff --git a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts index b650bfc33ebae..7829c432d3c6c 100644 --- a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts +++ b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts @@ -12,7 +12,7 @@ import { EmbeddableInput, IContainer, } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; interface EmbeddableTimeRangeInput extends EmbeddableInput { timeRange: TimeRange; diff --git a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts index ce04ee022c684..413215eb2796e 100644 --- a/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts +++ b/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts @@ -11,7 +11,7 @@ import { IContainer, EmbeddableFactoryDefinition, } from '@kbn/embeddable-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { TIME_RANGE_EMBEDDABLE, TimeRangeEmbeddable } from './time_range_embeddable'; interface EmbeddableTimeRangeInput extends EmbeddableInput { diff --git a/src/plugins/unified_search/public/dataview_picker/change_dataview.test.tsx b/src/plugins/unified_search/public/dataview_picker/change_dataview.test.tsx index d3081561a0c4e..f567f3b6ac47b 100644 --- a/src/plugins/unified_search/public/dataview_picker/change_dataview.test.tsx +++ b/src/plugins/unified_search/public/dataview_picker/change_dataview.test.tsx @@ -116,7 +116,7 @@ describe('DataView component', () => { await act(async () => { const component = mount(wrapDataViewComponentInContext(props, true)); findTestSubject(component, 'dataview-trigger').simulate('click'); - expect(component.find('[data-test-subj="idataview-create-new"]').length).toBe(0); + expect(component.find('[data-test-subj="dataview-create-new"]').length).toBe(0); }); }); diff --git a/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx b/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx index f982f4cc2280f..52eb26bf737a3 100644 --- a/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx +++ b/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx @@ -11,7 +11,7 @@ import classNames from 'classnames'; import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import deepEqual from 'fast-deep-equal'; import useObservable from 'react-use/lib/useObservable'; -import type { Filter, TimeRange } from '@kbn/es-query'; +import type { Filter, TimeRange, Query } from '@kbn/es-query'; import { EMPTY } from 'rxjs'; import { map } from 'rxjs/operators'; import { @@ -25,12 +25,7 @@ import { useIsWithinBreakpoints, EuiSuperUpdateButton, } from '@elastic/eui'; -import { - IDataPluginServices, - TimeHistoryContract, - Query, - getQueryLog, -} from '@kbn/data-plugin/public'; +import { IDataPluginServices, TimeHistoryContract, getQueryLog } from '@kbn/data-plugin/public'; import { i18n } from '@kbn/i18n'; import { DataView } from '@kbn/data-views-plugin/public'; import type { PersistedLog } from '@kbn/data-plugin/public'; diff --git a/src/plugins/unified_search/public/query_string_input/query_string_input.tsx b/src/plugins/unified_search/public/query_string_input/query_string_input.tsx index dc606690fb7dd..301ad1dba432a 100644 --- a/src/plugins/unified_search/public/query_string_input/query_string_input.tsx +++ b/src/plugins/unified_search/public/query_string_input/query_string_input.tsx @@ -29,7 +29,8 @@ import { import { FormattedMessage } from '@kbn/i18n-react'; import { compact, debounce, isEmpty, isEqual, isFunction } from 'lodash'; import { Toast } from '@kbn/core/public'; -import { IDataPluginServices, Query, getQueryLog } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { IDataPluginServices, getQueryLog } from '@kbn/data-plugin/public'; import { DataView } from '@kbn/data-views-plugin/public'; import type { PersistedLog } from '@kbn/data-plugin/public'; import { getFieldSubtypeNested, KIBANA_USER_QUERY_LANGUAGE_KEY } from '@kbn/data-plugin/common'; diff --git a/src/plugins/unified_search/public/search_bar/create_search_bar.tsx b/src/plugins/unified_search/public/search_bar/create_search_bar.tsx index a4e1988c0dfee..7fbb9df37b741 100644 --- a/src/plugins/unified_search/public/search_bar/create_search_bar.tsx +++ b/src/plugins/unified_search/public/search_bar/create_search_bar.tsx @@ -12,7 +12,7 @@ import { CoreStart } from '@kbn/core/public'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { QueryStart, SavedQuery, DataPublicPluginStart } from '@kbn/data-plugin/public'; -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; import type { Filter, TimeRange } from '@kbn/es-query'; import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/public'; import { SearchBar } from '.'; diff --git a/src/plugins/unified_search/public/search_bar/lib/populate_state_from_saved_query.test.ts b/src/plugins/unified_search/public/search_bar/lib/populate_state_from_saved_query.test.ts index 67a2e4ea71c6a..8cbab63956384 100644 --- a/src/plugins/unified_search/public/search_bar/lib/populate_state_from_saved_query.test.ts +++ b/src/plugins/unified_search/public/search_bar/lib/populate_state_from_saved_query.test.ts @@ -10,7 +10,7 @@ import { populateStateFromSavedQuery } from './populate_state_from_saved_query'; import { dataPluginMock } from '@kbn/data-plugin/public/mocks'; import { DataPublicPluginStart, SavedQuery } from '@kbn/data-plugin/public'; import { getFilter } from '../../test_helpers/get_stub_filter'; -import { FilterStateStore } from '@kbn/data-plugin/common'; +import { FilterStateStore } from '@kbn/es-query'; describe('populateStateFromSavedQuery', () => { let dataMock: jest.Mocked; diff --git a/src/plugins/unified_search/public/search_bar/lib/use_query_string_manager.ts b/src/plugins/unified_search/public/search_bar/lib/use_query_string_manager.ts index 10b2c7b64e97c..e3e6ceb350812 100644 --- a/src/plugins/unified_search/public/search_bar/lib/use_query_string_manager.ts +++ b/src/plugins/unified_search/public/search_bar/lib/use_query_string_manager.ts @@ -8,7 +8,7 @@ import { useState, useEffect, useMemo } from 'react'; import { Subscription } from 'rxjs'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { QueryStringContract } from '@kbn/data-plugin/public'; interface UseQueryStringProps { diff --git a/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts b/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts index 10444d1d19055..4e0a5037158b6 100644 --- a/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts +++ b/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import { FilterStateStore } from '@kbn/data-plugin/public'; -import type { Filter } from '@kbn/es-query'; +import { type Filter, FilterStateStore } from '@kbn/es-query'; export function getFilter( store: FilterStateStore, diff --git a/src/plugins/vis_default_editor/public/components/agg.tsx b/src/plugins/vis_default_editor/public/components/agg.tsx index 3413eb46a9c34..e3794077b005d 100644 --- a/src/plugins/vis_default_editor/public/components/agg.tsx +++ b/src/plugins/vis_default_editor/public/components/agg.tsx @@ -16,7 +16,8 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { IAggConfig, TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { IAggConfig } from '@kbn/data-plugin/public'; import { DefaultEditorAggParams } from './agg_params'; import { DefaultEditorAggCommonProps } from './agg_common_props'; import { AGGS_ACTION_KEYS, AggsAction } from './agg_group_state'; diff --git a/src/plugins/vis_default_editor/public/components/agg_group.tsx b/src/plugins/vis_default_editor/public/components/agg_group.tsx index 26304ba7f17f0..7f09431d2ea7f 100644 --- a/src/plugins/vis_default_editor/public/components/agg_group.tsx +++ b/src/plugins/vis_default_editor/public/components/agg_group.tsx @@ -19,7 +19,8 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { AggGroupNames, AggGroupLabels, IAggConfig, TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { AggGroupNames, AggGroupLabels, IAggConfig } from '@kbn/data-plugin/public'; import type { Schema } from '@kbn/visualizations-plugin/public'; import { DefaultEditorAgg } from './agg'; import { DefaultEditorAggAdd } from './agg_add'; diff --git a/src/plugins/vis_default_editor/public/components/controls/filter.tsx b/src/plugins/vis_default_editor/public/components/controls/filter.tsx index 9796179ed2a9c..95740cbaa9624 100644 --- a/src/plugins/vis_default_editor/public/components/controls/filter.tsx +++ b/src/plugins/vis_default_editor/public/components/controls/filter.tsx @@ -10,7 +10,8 @@ import React, { useState } from 'react'; import { EuiForm, EuiButtonIcon, EuiFieldText, EuiFormRow, EuiSpacer } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { IAggConfig, Query, DataPublicPluginStart } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { IAggConfig, DataPublicPluginStart } from '@kbn/data-plugin/public'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import { useKibana } from '@kbn/kibana-react-plugin/public'; diff --git a/src/plugins/vis_default_editor/public/components/controls/filters.tsx b/src/plugins/vis_default_editor/public/components/controls/filters.tsx index 3236e16903b9f..8b878d4362def 100644 --- a/src/plugins/vis_default_editor/public/components/controls/filters.tsx +++ b/src/plugins/vis_default_editor/public/components/controls/filters.tsx @@ -12,7 +12,8 @@ import { htmlIdGenerator, EuiButton, EuiSpacer } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import useMount from 'react-use/lib/useMount'; -import { Query, DataPublicPluginStart } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { IUiSettingsClient } from '@kbn/core/public'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { FilterRow } from './filter'; diff --git a/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx b/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx index c7b2878e2656b..c68359606f1b8 100644 --- a/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx +++ b/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx @@ -10,13 +10,8 @@ import React, { useMemo, useCallback } from 'react'; import { findLast } from 'lodash'; import { EuiSpacer } from '@elastic/eui'; -import { - AggGroupNames, - IAggConfig, - IMetricAggType, - search, - TimeRange, -} from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { AggGroupNames, IAggConfig, IMetricAggType, search } from '@kbn/data-plugin/public'; import type { ISchemas } from '@kbn/visualizations-plugin/public'; import { DefaultEditorAggGroup } from '../agg_group'; import { diff --git a/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx b/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx index bb8d6d9ecf97f..e1bafe8e67fea 100644 --- a/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx +++ b/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx @@ -25,7 +25,7 @@ import { VisualizeEmbeddableContract, } from '@kbn/visualizations-plugin/public'; import type { Schema } from '@kbn/visualizations-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { SavedSearch } from '@kbn/discover-plugin/public'; import { DefaultEditorNavBar } from './navbar'; import { DefaultEditorControls } from './controls'; diff --git a/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts b/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts index b31de9e7c9383..487ad390a62dc 100644 --- a/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts +++ b/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts @@ -9,8 +9,8 @@ import { i18n } from '@kbn/i18n'; import type { KibanaExecutionContext } from '@kbn/core/public'; import { DataView } from '@kbn/data-plugin/common'; -import { Filter, buildEsQuery } from '@kbn/es-query'; -import { KibanaContext, TimeRange, Query, getEsQueryConfig } from '@kbn/data-plugin/public'; +import { Filter, buildEsQuery, TimeRange, Query } from '@kbn/es-query'; +import { KibanaContext, getEsQueryConfig } from '@kbn/data-plugin/public'; import { TimelionVisDependencies } from '../plugin'; import { getTimezone } from './get_timezone'; import { TimelionVisParams } from '../timelion_vis_fn'; diff --git a/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts b/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts index 6f92d02682b53..3a268e61690a1 100644 --- a/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts +++ b/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts @@ -8,9 +8,9 @@ import { get } from 'lodash'; import { i18n } from '@kbn/i18n'; -import { Filter } from '@kbn/es-query'; +import { Filter, Query, TimeRange } from '@kbn/es-query'; import { ExpressionFunctionDefinition, Render } from '@kbn/expressions-plugin/public'; -import { KibanaContext, Query, TimeRange } from '@kbn/data-plugin/public'; +import { KibanaContext } from '@kbn/data-plugin/public'; import { TimelionSuccessResponse } from './helpers/timelion_request_handler'; import { TIMELION_VIS_NAME } from './timelion_vis_type'; import { TimelionVisDependencies } from './plugin'; diff --git a/src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx b/src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx index 3b7de8c4e4a7f..49ae7ea348f5a 100644 --- a/src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx +++ b/src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx @@ -21,7 +21,8 @@ import { } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { KBN_FIELD_TYPES, Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { KBN_FIELD_TYPES } from '@kbn/data-plugin/public'; import { getDataViewsStart } from '../../services'; import { AddDeleteButtons } from './add_delete_buttons'; diff --git a/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts b/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts index 1219a7fde22cc..c3b096f0eef01 100644 --- a/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts +++ b/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts @@ -7,7 +7,7 @@ */ import { DataView } from '@kbn/data-views-plugin/public'; import { DatatableRow, DatatableColumn, DatatableColumnType } from '@kbn/expressions-plugin/public'; -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; import { BUCKET_TYPES as DATA_PLUGIN_BUCKET_TYPES, MultiFieldKey } from '@kbn/data-plugin/common'; import { TimeseriesVisParams } from '../../../types'; import type { PanelData, Metric } from '../../../../common/types'; diff --git a/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx b/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx index 4ccaf99415267..587c665c89041 100644 --- a/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx +++ b/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx @@ -18,7 +18,7 @@ import type { Vis, VisualizeEmbeddableContract } from '@kbn/visualizations-plugi import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { Storage } from '@kbn/kibana-utils-plugin/public'; -import type { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import type { EditorRenderProps } from '@kbn/visualizations-plugin/public'; import type { IndexPatternValue, TimeseriesVisData } from '../../../common/types'; diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/get_series.test.ts b/src/plugins/vis_types/timeseries/public/trigger_action/get_series.test.ts index 40fa06ba427a1..fe51f034f70c8 100644 --- a/src/plugins/vis_types/timeseries/public/trigger_action/get_series.test.ts +++ b/src/plugins/vis_types/timeseries/public/trigger_action/get_series.test.ts @@ -17,7 +17,7 @@ describe('getSeries', () => { field: 'day_of_week_i', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'average', @@ -44,7 +44,7 @@ describe('getSeries', () => { }, }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -71,7 +71,7 @@ describe('getSeries', () => { field: '123456', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -97,7 +97,7 @@ describe('getSeries', () => { field: '123456', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -122,7 +122,7 @@ describe('getSeries', () => { field: '123456', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'cumulative_sum', @@ -147,7 +147,7 @@ describe('getSeries', () => { field: '123456', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -174,7 +174,7 @@ describe('getSeries', () => { unit: '1m', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'differences', @@ -202,7 +202,7 @@ describe('getSeries', () => { window: 6, }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'moving_average', @@ -246,7 +246,7 @@ describe('getSeries', () => { window: 6, }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -293,7 +293,7 @@ describe('getSeries', () => { ], }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'percentile', @@ -335,7 +335,7 @@ describe('getSeries', () => { colors: ['rgba(211,96,134,1)', 'rgba(155,33,230,1)', '#68BC00'], }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'percentile_rank', @@ -377,7 +377,7 @@ describe('getSeries', () => { order_by: 'timestamp', }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'last_value', @@ -390,6 +390,37 @@ describe('getSeries', () => { ]); }); + test('should split out the series agg metric and return it as a separate property', () => { + const metric = [ + { + id: '12345', + type: 'top_hit', + field: 'day_of_week_i', + size: 1, + order_by: 'timestamp', + }, + { + id: '6789', + type: 'series_agg', + function: 'mean', + }, + ] as Metric[]; + const config = getSeries(metric, 1)!; + expect(config).toStrictEqual({ + metrics: [ + { + agg: 'last_value', + fieldName: 'day_of_week_i', + isFullReference: false, + params: { + sortField: 'timestamp', + }, + }, + ], + seriesAgg: 'avg', + }); + }); + test('should return null for a top_hit size >1 aggregation', () => { const metric = [ { @@ -423,7 +454,7 @@ describe('getSeries', () => { value: '10', }, ] as Metric[]; - const config = getSeries(metric, 2); + const config = getSeries(metric, 2)!.metrics; expect(config).toStrictEqual([ { agg: 'static_value', @@ -490,7 +521,7 @@ describe('getSeries', () => { ], }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', @@ -541,7 +572,7 @@ describe('getSeries', () => { ], }, ] as Metric[]; - const config = getSeries(metric, 1); + const config = getSeries(metric, 1)!.metrics; expect(config).toStrictEqual([ { agg: 'formula', diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/get_series.ts b/src/plugins/vis_types/timeseries/public/trigger_action/get_series.ts index e180df5b4c1a9..74cbe3337af48 100644 --- a/src/plugins/vis_types/timeseries/public/trigger_action/get_series.ts +++ b/src/plugins/vis_types/timeseries/public/trigger_action/get_series.ts @@ -8,6 +8,7 @@ import type { VisualizeEditorLayersContext } from '@kbn/visualizations-plugin/public'; import type { Metric } from '../../common/types'; import { SUPPORTED_METRICS } from './supported_metrics'; +import { getSeriesAgg } from './get_series_agg'; import { getPercentilesSeries, getPercentileRankSeries, @@ -23,9 +24,10 @@ import { } from './metrics_helpers'; export const getSeries = ( - metrics: Metric[], + initialMetrics: Metric[], totalSeriesNum: number -): VisualizeEditorLayersContext['metrics'] | null => { +): { metrics: VisualizeEditorLayersContext['metrics']; seriesAgg?: string } | null => { + const { metrics, seriesAgg } = getSeriesAgg(initialMetrics); const metricIdx = metrics.length - 1; const aggregation = metrics[metricIdx].type; const fieldName = metrics[metricIdx].field; @@ -231,5 +233,5 @@ export const getSeries = ( ]; } } - return metricsArray; + return { metrics: metricsArray, seriesAgg }; }; diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/get_series_agg.ts b/src/plugins/vis_types/timeseries/public/trigger_action/get_series_agg.ts new file mode 100644 index 0000000000000..07bfd071acbaa --- /dev/null +++ b/src/plugins/vis_types/timeseries/public/trigger_action/get_series_agg.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import type { Metric } from '../../common/types'; + +const functionMap: Partial> = { + mean: 'avg', + min: 'min', + max: 'max', + sum: 'sum', +}; + +export const getSeriesAgg = (metrics: Metric[]) => { + const lastMetric = metrics[metrics.length - 1]; + + if (lastMetric.type === 'series_agg' && lastMetric.function && functionMap[lastMetric.function]) { + return { + metrics: metrics.slice(0, -1), + seriesAgg: functionMap[lastMetric.function], + }; + } else { + return { + metrics, + seriesAgg: undefined, + }; + } +}; diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/index.test.ts b/src/plugins/vis_types/timeseries/public/trigger_action/index.test.ts index 25edcb389932e..4a22f8ed7db18 100644 --- a/src/plugins/vis_types/timeseries/public/trigger_action/index.test.ts +++ b/src/plugins/vis_types/timeseries/public/trigger_action/index.test.ts @@ -117,6 +117,7 @@ describe('triggerTSVBtoLensConfiguration', () => { '0': { axisPosition: 'left', chartType: 'line', + collapseFn: undefined, indexPatternId: 'test2', metrics: [ { @@ -219,12 +220,19 @@ describe('triggerTSVBtoLensConfiguration', () => { ]); }); - test('should return termsParams information if the chart is broken down by terms', async () => { + test('should return termsParams information if the chart is broken down by terms including series agg collapse fn', async () => { const modelWithTerms = { ...model, series: [ { ...model.series[0], + metrics: [ + ...model.series[0].metrics, + { + type: 'series_agg', + function: 'sum', + }, + ], split_mode: 'terms', terms_size: 6, terms_direction: 'desc', @@ -233,6 +241,7 @@ describe('triggerTSVBtoLensConfiguration', () => { ] as unknown as Series[], }; const triggerOptions = await triggerTSVBtoLensConfiguration(modelWithTerms); + expect(triggerOptions?.layers[0]?.collapseFn).toStrictEqual('sum'); expect(triggerOptions?.layers[0]?.termsParams).toStrictEqual({ size: 6, otherBucket: false, @@ -290,6 +299,7 @@ describe('triggerTSVBtoLensConfiguration', () => { '0': { axisPosition: 'right', chartType: 'area_stacked', + collapseFn: undefined, indexPatternId: 'test2', metrics: [ { diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/index.ts b/src/plugins/vis_types/timeseries/public/trigger_action/index.ts index 80ef6500c130c..91af800ca16a1 100644 --- a/src/plugins/vis_types/timeseries/public/trigger_action/index.ts +++ b/src/plugins/vis_types/timeseries/public/trigger_action/index.ts @@ -69,10 +69,11 @@ export const triggerTSVBtoLensConfiguration = async ( } // handle multiple metrics - let metricsArray = getSeries(layer.metrics, seriesNum); - if (!metricsArray) { + const series = getSeries(layer.metrics, seriesNum); + if (!series) { return null; } + const { metrics: metricsArray, seriesAgg } = series; let filter: { kql?: string | { [key: string]: any } | undefined; lucene?: string | { [key: string]: any } | undefined; @@ -85,7 +86,7 @@ export const triggerTSVBtoLensConfiguration = async ( } } - metricsArray = metricsArray.map((metric) => { + const metricsWithParams = metricsArray.map((metric) => { return { ...metric, color: metric.color ?? layer.color, @@ -146,7 +147,8 @@ export const triggerTSVBtoLensConfiguration = async ( parentFormat: { id: 'terms' }, }, }), - metrics: [...metricsArray], + collapseFn: seriesAgg, + metrics: [...metricsWithParams], timeInterval: model.interval && !model.interval?.includes('=') ? model.interval : 'auto', ...(SUPPORTED_FORMATTERS.includes(layer.formatter) && { format: layer.formatter }), ...(layer.label && { label: layer.label }), diff --git a/src/plugins/vis_types/timeseries/public/trigger_action/metrics_helpers.ts b/src/plugins/vis_types/timeseries/public/trigger_action/metrics_helpers.ts index f6a368382b5b4..7eebd9a5c440b 100644 --- a/src/plugins/vis_types/timeseries/public/trigger_action/metrics_helpers.ts +++ b/src/plugins/vis_types/timeseries/public/trigger_action/metrics_helpers.ts @@ -5,7 +5,7 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; import type { Metric, MetricType } from '../../common/types'; import { SUPPORTED_METRICS } from './supported_metrics'; diff --git a/src/plugins/vis_types/vega/public/data_model/time_cache.ts b/src/plugins/vis_types/vega/public/data_model/time_cache.ts index 8ce622755cb83..d5f470f419b68 100644 --- a/src/plugins/vis_types/vega/public/data_model/time_cache.ts +++ b/src/plugins/vis_types/vega/public/data_model/time_cache.ts @@ -7,7 +7,7 @@ */ import { TimefilterContract } from '@kbn/data-plugin/public'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { CacheBounds } from './types'; /** diff --git a/src/plugins/vis_types/vega/public/vega_fn.ts b/src/plugins/vis_types/vega/public/vega_fn.ts index f8e9eff3bf555..6dbd7c9792502 100644 --- a/src/plugins/vis_types/vega/public/vega_fn.ts +++ b/src/plugins/vis_types/vega/public/vega_fn.ts @@ -14,7 +14,8 @@ import { ExpressionFunctionDefinition, Render, } from '@kbn/expressions-plugin/public'; -import { KibanaContext, TimeRange, Query } from '@kbn/data-plugin/public'; +import { TimeRange, Query } from '@kbn/es-query'; +import { KibanaContext } from '@kbn/data-plugin/public'; import { VegaVisualizationDependencies } from './plugin'; import { VegaInspectorAdapters } from './vega_inspector'; import { VegaParser } from './data_model/vega_parser'; diff --git a/src/plugins/vis_types/vega/public/vega_request_handler.ts b/src/plugins/vis_types/vega/public/vega_request_handler.ts index 84b5663df0be6..6665b204ae929 100644 --- a/src/plugins/vis_types/vega/public/vega_request_handler.ts +++ b/src/plugins/vis_types/vega/public/vega_request_handler.ts @@ -7,8 +7,8 @@ */ import type { KibanaExecutionContext } from '@kbn/core/public'; import type { DataView } from '@kbn/data-views-plugin/common'; -import { Filter, buildEsQuery } from '@kbn/es-query'; -import { getEsQueryConfig, TimeRange, Query } from '@kbn/data-plugin/public'; +import { Filter, buildEsQuery, TimeRange, Query } from '@kbn/es-query'; +import { getEsQueryConfig } from '@kbn/data-plugin/public'; import { SearchAPI } from './data_model/search_api'; import { TimeCache } from './data_model/time_cache'; diff --git a/src/plugins/visualizations/common/locator.test.ts b/src/plugins/visualizations/common/locator.test.ts index 7dcdd7191d60b..4c851704dfbee 100644 --- a/src/plugins/visualizations/common/locator.test.ts +++ b/src/plugins/visualizations/common/locator.test.ts @@ -7,7 +7,7 @@ */ import { VisualizeLocatorDefinition } from './locator'; -import { FilterStateStore } from '@kbn/data-plugin/common'; +import { FilterStateStore } from '@kbn/es-query'; describe('visualize locator', () => { let definition: VisualizeLocatorDefinition; diff --git a/src/plugins/visualizations/common/locator.ts b/src/plugins/visualizations/common/locator.ts index 60ac8230090fb..fdb2800ec3a96 100644 --- a/src/plugins/visualizations/common/locator.ts +++ b/src/plugins/visualizations/common/locator.ts @@ -7,8 +7,8 @@ */ import type { SerializableRecord } from '@kbn/utility-types'; -import { Filter } from '@kbn/es-query'; -import type { Query, RefreshInterval, TimeRange } from '@kbn/data-plugin/common'; +import type { Filter, Query, TimeRange } from '@kbn/es-query'; +import type { RefreshInterval } from '@kbn/data-plugin/common'; import type { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/common'; import type { SavedVisState } from './types'; diff --git a/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx b/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx index 8616a2c72c431..66f888df25010 100644 --- a/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx +++ b/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx @@ -12,10 +12,10 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; import { render } from 'react-dom'; import { EuiLoadingChart } from '@elastic/eui'; -import { Filter, onlyDisabledFiltersChanged } from '@kbn/es-query'; +import { Filter, onlyDisabledFiltersChanged, Query, TimeRange } from '@kbn/es-query'; import type { KibanaExecutionContext, SavedObjectAttributes } from '@kbn/core/public'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; -import { Query, TimefilterContract, TimeRange } from '@kbn/data-plugin/public'; +import { TimefilterContract } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { Adapters, diff --git a/src/plugins/visualizations/public/vis_types/types.ts b/src/plugins/visualizations/public/vis_types/types.ts index 8f6dc309a7145..970a9c1d730fb 100644 --- a/src/plugins/visualizations/public/vis_types/types.ts +++ b/src/plugins/visualizations/public/vis_types/types.ts @@ -10,7 +10,8 @@ import type { IconType } from '@elastic/eui'; import type { ReactNode } from 'react'; import type { PaletteOutput } from '@kbn/coloring'; import type { Adapters } from '@kbn/inspector-plugin'; -import type { AggGroupNames, AggParam, AggGroupName, Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import type { AggGroupNames, AggParam, AggGroupName } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import type { Vis, VisEditorOptionsProps, VisParams, VisToExpressionAst } from '../types'; import { VisGroups } from './vis_groups_enum'; @@ -97,6 +98,7 @@ export interface VisualizeEditorLayersContext { termsParams?: Record; splitFields?: string[]; splitMode?: string; + collapseFn?: string; splitFilters?: SplitByFilters[]; palette?: PaletteOutput; metrics: VisualizeEditorMetricContext[]; diff --git a/src/plugins/visualizations/public/visualize_app/types.ts b/src/plugins/visualizations/public/visualize_app/types.ts index a940063067e89..cf46e0fc4ff1e 100644 --- a/src/plugins/visualizations/public/visualize_app/types.ts +++ b/src/plugins/visualizations/public/visualize_app/types.ts @@ -28,8 +28,8 @@ import type { import type { DataViewEditorStart } from '@kbn/data-view-editor-plugin/public'; import type { NavigationPublicPluginStart as NavigationStart } from '@kbn/navigation-plugin/public'; -import type { Filter } from '@kbn/es-query'; -import type { Query, DataPublicPluginStart, TimeRange } from '@kbn/data-plugin/public'; +import type { Filter, Query, TimeRange } from '@kbn/es-query'; +import type { DataPublicPluginStart } from '@kbn/data-plugin/public'; import type { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; import type { SharePluginStart } from '@kbn/share-plugin/public'; import type { EmbeddableStart, EmbeddableStateTransfer } from '@kbn/embeddable-plugin/public'; diff --git a/src/plugins/visualizations/public/visualize_app/utils/migrate_legacy_query.ts b/src/plugins/visualizations/public/visualize_app/utils/migrate_legacy_query.ts index 9c7beafdeb22d..417c20b9d6967 100644 --- a/src/plugins/visualizations/public/visualize_app/utils/migrate_legacy_query.ts +++ b/src/plugins/visualizations/public/visualize_app/utils/migrate_legacy_query.ts @@ -7,7 +7,7 @@ */ import { has } from 'lodash'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; /** * Creates a standardized query object from old queries that were either strings or pure ES query DSL diff --git a/test/scripts/checks/doc_api_changes.sh b/test/scripts/checks/doc_api_changes.sh deleted file mode 100755 index f2f508fd8f7d4..0000000000000 --- a/test/scripts/checks/doc_api_changes.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env bash - -source src/dev/ci_setup/setup_env.sh - -checks-reporter-with-killswitch "Check Doc API Changes" \ - node scripts/check_published_api_changes diff --git a/test/scripts/jenkins_unit.sh b/test/scripts/jenkins_unit.sh index b852a5b313ad9..e0ff16f387e3d 100755 --- a/test/scripts/jenkins_unit.sh +++ b/test/scripts/jenkins_unit.sh @@ -16,7 +16,6 @@ if [[ -z "$CODE_COVERAGE" ]] ; then ./test/scripts/checks/telemetry.sh ./test/scripts/checks/ts_projects.sh ./test/scripts/checks/jest_configs.sh - ./test/scripts/checks/doc_api_changes.sh ./test/scripts/checks/type_check.sh ./test/scripts/checks/bundle_limits.sh ./test/scripts/checks/i18n.sh diff --git a/vars/tasks.groovy b/vars/tasks.groovy index ee440c9c11731..0f44ad0658043 100644 --- a/vars/tasks.groovy +++ b/vars/tasks.groovy @@ -8,7 +8,6 @@ def check() { kibanaPipeline.scriptTask('Check Telemetry Schema', 'test/scripts/checks/telemetry.sh'), kibanaPipeline.scriptTask('Check TypeScript Projects', 'test/scripts/checks/ts_projects.sh'), kibanaPipeline.scriptTask('Check Jest Configs', 'test/scripts/checks/jest_configs.sh'), - kibanaPipeline.scriptTask('Check Doc API Changes', 'test/scripts/checks/doc_api_changes.sh'), kibanaPipeline.scriptTask('Check @kbn/pm Distributable', 'test/scripts/checks/kbn_pm_dist.sh'), kibanaPipeline.scriptTask('Check Plugin List Docs', 'test/scripts/checks/plugin_list_docs.sh'), kibanaPipeline.scriptTask('Check Types and Public API Docs', 'test/scripts/checks/type_check_plugin_public_api_docs.sh'), diff --git a/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.test.ts b/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.test.ts index 6dd2075f648d9..579432e69030b 100644 --- a/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.test.ts +++ b/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.test.ts @@ -10,7 +10,7 @@ import { schema } from '@kbn/config-schema'; import { ActionsConfig } from '../config'; import { ActionsPluginsStart } from '../plugin'; import { spacesMock } from '@kbn/spaces-plugin/server/mocks'; -import { esKuery } from '@kbn/data-plugin/server'; +import { toElasticsearchQuery } from '@kbn/es-query'; import { loggingSystemMock, savedObjectsRepositoryMock, @@ -95,7 +95,7 @@ describe('findAndCleanupTasks', () => { sortField: 'runAt', sortOrder: 'asc', }); - expect(esKuery.toElasticsearchQuery(savedObjectsRepository.find.mock.calls[0][0].filter)) + expect(toElasticsearchQuery(savedObjectsRepository.find.mock.calls[0][0].filter)) .toMatchInlineSnapshot(` Object { "bool": Object { diff --git a/x-pack/plugins/alerting/common/rule_snooze_type.ts b/x-pack/plugins/alerting/common/rule_snooze_type.ts index 405cbef357242..335f1b4180727 100644 --- a/x-pack/plugins/alerting/common/rule_snooze_type.ts +++ b/x-pack/plugins/alerting/common/rule_snooze_type.ts @@ -7,11 +7,21 @@ import type { WeekdayStr } from 'rrule'; -export type RuleSnooze = Array<{ +type SnoozeRRule = Partial & Pick; + +export interface RuleSnoozeSchedule { duration: number; - rRule: Partial & Pick; + rRule: SnoozeRRule; // For scheduled/recurring snoozes, `id` uniquely identifies them so that they can be displayed, modified, and deleted individually id?: string; +} + +// Type signature of has to be repeated here to avoid issues with SavedObject compatibility +// RuleSnooze = RuleSnoozeSchedule[] throws typescript errors across the whole lib +export type RuleSnooze = Array<{ + duration: number; + rRule: SnoozeRRule; + id?: string; }>; // An iCal RRULE to define a recurrence schedule, see https://github.com/jakubroztocil/rrule for the spec @@ -26,7 +36,7 @@ export interface RRuleRecord { byweekday?: Array; bymonth?: number[]; bysetpos?: number[]; - bymonthday: number; + bymonthday: number[]; byyearday: number[]; byweekno: number[]; byhour: number[]; diff --git a/x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts b/x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts index 7ae4b99e4df75..2e9dfe7003e27 100644 --- a/x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts +++ b/x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts @@ -6,47 +6,63 @@ */ import { RRule, ByWeekday, Weekday, rrulestr } from 'rrule'; +import { first } from 'lodash'; import { SanitizedRule, RuleTypeParams } from '../../common/rule'; type RuleSnoozeProps = Pick, 'muteAll' | 'snoozeSchedule'>; +type ActiveSnoozes = Array<{ snoozeEndTime: Date; id: string }>; -export function getRuleSnoozeEndTime(rule: RuleSnoozeProps): Date | null { +export function getActiveSnoozes(rule: RuleSnoozeProps): ActiveSnoozes | null { if (rule.snoozeSchedule == null) { return null; } const now = Date.now(); - for (const snooze of rule.snoozeSchedule) { - const { duration, rRule } = snooze; - const startTimeMS = Date.parse(rRule.dtstart); - const initialEndTime = startTimeMS + duration; - // If now is during the first occurrence of the snooze - - if (now >= startTimeMS && now < initialEndTime) return new Date(initialEndTime); - - // Check to see if now is during a recurrence of the snooze - if (rRule) { - try { - const rRuleOptions = { - ...rRule, - dtstart: new Date(rRule.dtstart), - until: rRule.until ? new Date(rRule.until) : null, - wkst: rRule.wkst ? Weekday.fromStr(rRule.wkst) : null, - byweekday: rRule.byweekday ? parseByWeekday(rRule.byweekday) : null, - }; - - const recurrenceRule = new RRule(rRuleOptions); - const lastOccurrence = recurrenceRule.before(new Date(now), true); - if (!lastOccurrence) continue; - const lastOccurrenceEndTime = lastOccurrence.getTime() + duration; - if (now < lastOccurrenceEndTime) return new Date(lastOccurrenceEndTime); - } catch (e) { - throw new Error(`Failed to process RRule ${rRule}: ${e}`); - } - } - } + return ( + rule.snoozeSchedule + .map((snooze) => { + const { duration, rRule, id } = snooze; + const startTimeMS = Date.parse(rRule.dtstart); + const initialEndTime = startTimeMS + duration; + // If now is during the first occurrence of the snooze + + if (now >= startTimeMS && now < initialEndTime) + return { + snoozeEndTime: new Date(initialEndTime), + id, + }; + + // Check to see if now is during a recurrence of the snooze + if (rRule) { + try { + const rRuleOptions = { + ...rRule, + dtstart: new Date(rRule.dtstart), + until: rRule.until ? new Date(rRule.until) : null, + wkst: rRule.wkst ? Weekday.fromStr(rRule.wkst) : null, + byweekday: rRule.byweekday ? parseByWeekday(rRule.byweekday) : null, + }; - return null; + const recurrenceRule = new RRule(rRuleOptions); + const lastOccurrence = recurrenceRule.before(new Date(now), true); + if (!lastOccurrence) return null; + const lastOccurrenceEndTime = lastOccurrence.getTime() + duration; + if (now < lastOccurrenceEndTime) + return { snoozeEndTime: new Date(lastOccurrenceEndTime), id }; + } catch (e) { + throw new Error(`Failed to process RRule ${rRule}: ${e}`); + } + } + return null; + }) + .filter(Boolean) + // Sort in descending snoozeEndTime order + .sort((a, b) => b!.snoozeEndTime.getTime() - a!.snoozeEndTime.getTime()) as ActiveSnoozes + ); +} + +export function getRuleSnoozeEndTime(rule: RuleSnoozeProps): Date | null { + return first(getActiveSnoozes(rule))?.snoozeEndTime ?? null; } export function isRuleSnoozed(rule: RuleSnoozeProps) { diff --git a/x-pack/plugins/alerting/server/lib/validate_snooze_date.ts b/x-pack/plugins/alerting/server/lib/validate_snooze_date.ts index deb951a717a06..91d8a2943d394 100644 --- a/x-pack/plugins/alerting/server/lib/validate_snooze_date.ts +++ b/x-pack/plugins/alerting/server/lib/validate_snooze_date.ts @@ -5,9 +5,15 @@ * 2.0. */ -export const validateSnoozeDate = (date: string) => { +export const validateSnoozeEndDate = (date: string) => { const parsedValue = Date.parse(date); if (isNaN(parsedValue)) return `Invalid date: ${date}`; if (parsedValue <= Date.now()) return `Invalid snooze date as it is in the past: ${date}`; return; }; + +export const validateSnoozeStartDate = (date: string) => { + const parsedValue = Date.parse(date); + if (isNaN(parsedValue)) return `Invalid date: ${date}`; + return; +}; diff --git a/x-pack/plugins/alerting/server/routes/snooze_rule.test.ts b/x-pack/plugins/alerting/server/routes/snooze_rule.test.ts index dd0af1c77ac1a..ab24103672521 100644 --- a/x-pack/plugins/alerting/server/routes/snooze_rule.test.ts +++ b/x-pack/plugins/alerting/server/routes/snooze_rule.test.ts @@ -21,8 +21,14 @@ beforeEach(() => { jest.resetAllMocks(); }); -// These tests don't test for future snooze time validation, so this date doesn't need to be in the future -const SNOOZE_END_TIME = '2021-03-07T00:00:00.000Z'; +const SNOOZE_SCHEDULE = { + rRule: { + dtstart: '2021-03-07T00:00:00.000Z', + tzid: 'UTC', + count: 1, + }, + duration: 864000000, +}; describe('snoozeAlertRoute', () => { it('snoozes an alert', async () => { @@ -44,7 +50,7 @@ describe('snoozeAlertRoute', () => { id: '1', }, body: { - snooze_end_time: SNOOZE_END_TIME, + snooze_schedule: SNOOZE_SCHEDULE, }, }, ['noContent'] @@ -57,7 +63,14 @@ describe('snoozeAlertRoute', () => { Array [ Object { "id": "1", - "snoozeEndTime": "${SNOOZE_END_TIME}", + "snoozeSchedule": Object { + "duration": 864000000, + "rRule": Object { + "count": 1, + "dtstart": "2021-03-07T00:00:00.000Z", + "tzid": "UTC", + }, + }, }, ] `); @@ -84,7 +97,10 @@ describe('snoozeAlertRoute', () => { id: '1', }, body: { - snooze_end_time: -1, + snooze_schedule: { + ...SNOOZE_SCHEDULE, + duration: -1, + }, }, }, ['noContent'] @@ -97,7 +113,14 @@ describe('snoozeAlertRoute', () => { Array [ Object { "id": "1", - "snoozeEndTime": -1, + "snoozeSchedule": Object { + "duration": -1, + "rRule": Object { + "count": 1, + "dtstart": "2021-03-07T00:00:00.000Z", + "tzid": "UTC", + }, + }, }, ] `); diff --git a/x-pack/plugins/alerting/server/routes/snooze_rule.ts b/x-pack/plugins/alerting/server/routes/snooze_rule.ts index a408a4d3175df..c56d57230e876 100644 --- a/x-pack/plugins/alerting/server/routes/snooze_rule.ts +++ b/x-pack/plugins/alerting/server/routes/snooze_rule.ts @@ -8,26 +8,39 @@ import { IRouter } from '@kbn/core/server'; import { schema } from '@kbn/config-schema'; import { ILicenseState, RuleMutedError } from '../lib'; -import { verifyAccessAndContext, RewriteRequestCase } from './lib'; +import { verifyAccessAndContext } from './lib'; import { SnoozeOptions } from '../rules_client'; import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../types'; -import { validateSnoozeDate } from '../lib/validate_snooze_date'; +import { validateSnoozeStartDate, validateSnoozeEndDate } from '../lib/validate_snooze_date'; const paramSchema = schema.object({ id: schema.string(), }); const bodySchema = schema.object({ - snooze_end_time: schema.oneOf([ - schema.string({ - validate: validateSnoozeDate, + snooze_schedule: schema.object({ + id: schema.maybe(schema.string()), + duration: schema.number(), + rRule: schema.object({ + dtstart: schema.string({ validate: validateSnoozeStartDate }), + tzid: schema.string(), + freq: schema.maybe( + schema.oneOf([schema.literal(0), schema.literal(1), schema.literal(2), schema.literal(3)]) + ), + interval: schema.maybe(schema.number()), + until: schema.maybe(schema.string({ validate: validateSnoozeEndDate })), + count: schema.maybe(schema.number()), + byweekday: schema.maybe(schema.arrayOf(schema.string())), + bymonthday: schema.maybe(schema.arrayOf(schema.number())), + bymonth: schema.maybe(schema.arrayOf(schema.number())), }), - schema.literal(-1), - ]), + }), }); -const rewriteBodyReq: RewriteRequestCase = ({ snooze_end_time: snoozeEndTime }) => ({ - snoozeEndTime, +const rewriteBodyReq: (opts: { + snooze_schedule: SnoozeOptions['snoozeSchedule']; +}) => SnoozeOptions = ({ snooze_schedule: snoozeSchedule }) => ({ + snoozeSchedule, }); export const snoozeRuleRoute = ( diff --git a/x-pack/plugins/alerting/server/routes/unsnooze_rule.test.ts b/x-pack/plugins/alerting/server/routes/unsnooze_rule.test.ts index 0a67c3aa608dc..12a4c250bef1d 100644 --- a/x-pack/plugins/alerting/server/routes/unsnooze_rule.test.ts +++ b/x-pack/plugins/alerting/server/routes/unsnooze_rule.test.ts @@ -40,6 +40,9 @@ describe('unsnoozeAlertRoute', () => { params: { id: '1', }, + body: { + scheduleIds: undefined, + }, }, ['noContent'] ); diff --git a/x-pack/plugins/alerting/server/routes/unsnooze_rule.ts b/x-pack/plugins/alerting/server/routes/unsnooze_rule.ts index b91fb24bea56a..2f4187fd3aa28 100644 --- a/x-pack/plugins/alerting/server/routes/unsnooze_rule.ts +++ b/x-pack/plugins/alerting/server/routes/unsnooze_rule.ts @@ -8,13 +8,21 @@ import { IRouter } from '@kbn/core/server'; import { schema } from '@kbn/config-schema'; import { ILicenseState, RuleMutedError } from '../lib'; -import { verifyAccessAndContext } from './lib'; +import { verifyAccessAndContext, RewriteRequestCase } from './lib'; import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../types'; const paramSchema = schema.object({ id: schema.string(), }); +const bodySchema = schema.object({ + schedule_ids: schema.maybe(schema.arrayOf(schema.string())), +}); + +const rewriteBodyReq: RewriteRequestCase<{ scheduleIds?: string[] }> = ({ + schedule_ids: scheduleIds, +}) => (scheduleIds ? { scheduleIds } : {}); + export const unsnoozeRuleRoute = ( router: IRouter, licenseState: ILicenseState @@ -24,14 +32,16 @@ export const unsnoozeRuleRoute = ( path: `${INTERNAL_BASE_ALERTING_API_PATH}/rule/{id}/_unsnooze`, validate: { params: paramSchema, + body: bodySchema, }, }, router.handleLegacyErrors( verifyAccessAndContext(licenseState, async function (context, req, res) { const rulesClient = (await context.alerting).getRulesClient(); const params = req.params; + const body = rewriteBodyReq(req.body); try { - await rulesClient.unsnooze({ ...params }); + await rulesClient.unsnooze({ ...params, ...body }); return res.noContent(); } catch (e) { if (e instanceof RuleMutedError) { diff --git a/x-pack/plugins/alerting/server/rules_client/rules_client.ts b/x-pack/plugins/alerting/server/rules_client/rules_client.ts index 30861ee1ab5a4..cf5592579806b 100644 --- a/x-pack/plugins/alerting/server/rules_client/rules_client.ts +++ b/x-pack/plugins/alerting/server/rules_client/rules_client.ts @@ -55,6 +55,7 @@ import { SanitizedRuleWithLegacyId, PartialRuleWithLegacyId, RuleSnooze, + RuleSnoozeSchedule, RawAlertInstance as RawAlert, } from '../types'; import { @@ -106,9 +107,10 @@ import { getExecutionLogAggregation, } from '../lib/get_execution_log_aggregation'; import { IExecutionLogWithErrorsResult } from '../../common'; -import { validateSnoozeDate } from '../lib/validate_snooze_date'; +import { validateSnoozeStartDate } from '../lib/validate_snooze_date'; import { RuleMutedError } from '../lib/errors/rule_muted'; import { formatExecutionErrorsResult } from '../lib/format_execution_log_errors'; +import { getActiveSnoozes } from '../lib/is_rule_snoozed'; export interface RegistryAlertTypeWithAuth extends RegistryRuleType { authorizedConsumers: string[]; @@ -192,7 +194,7 @@ export interface MuteOptions extends IndexType { } export interface SnoozeOptions extends IndexType { - snoozeEndTime: string | -1; + snoozeSchedule: RuleSnoozeSchedule; } export interface FindOptions extends IndexType { @@ -2099,29 +2101,35 @@ export class RulesClient { public async snooze({ id, - snoozeEndTime, + snoozeSchedule, }: { id: string; - snoozeEndTime: string | -1; + snoozeSchedule: RuleSnoozeSchedule; }): Promise { - if (typeof snoozeEndTime === 'string') { - const snoozeDateValidationMsg = validateSnoozeDate(snoozeEndTime); - if (snoozeDateValidationMsg) { - throw new RuleMutedError(snoozeDateValidationMsg); - } + const snoozeDateValidationMsg = validateSnoozeStartDate(snoozeSchedule.rRule.dtstart); + if (snoozeDateValidationMsg) { + throw new RuleMutedError(snoozeDateValidationMsg); } + return await retryIfConflicts( this.logger, - `rulesClient.snooze('${id}', ${snoozeEndTime})`, - async () => await this.snoozeWithOCC({ id, snoozeEndTime }) + `rulesClient.snooze('${id}', ${JSON.stringify(snoozeSchedule, null, 4)})`, + async () => await this.snoozeWithOCC({ id, snoozeSchedule }) ); } - private async snoozeWithOCC({ id, snoozeEndTime }: { id: string; snoozeEndTime: string | -1 }) { + private async snoozeWithOCC({ + id, + snoozeSchedule, + }: { + id: string; + snoozeSchedule: RuleSnoozeSchedule; + }) { const { attributes, version } = await this.unsecuredSavedObjectsClient.get( 'alert', id ); + const { id: snoozeId, duration } = snoozeSchedule; try { await this.authorization.ensureAuthorized({ @@ -2155,22 +2163,18 @@ export class RulesClient { this.ruleTypeRegistry.ensureRuleTypeEnabled(attributes.alertTypeId); - // If snoozeEndTime is -1, instead mute all + // If duration is -1, instead mute all const newAttrs = - snoozeEndTime === -1 + duration === -1 ? { muteAll: true, snoozeSchedule: clearUnscheduledSnooze(attributes), } : { - snoozeSchedule: clearUnscheduledSnooze(attributes).concat({ - duration: Date.parse(snoozeEndTime) - Date.now(), - rRule: { - dtstart: new Date().toISOString(), - tzid: 'UTC', - count: 1, - }, - }), + snoozeSchedule: (snoozeId + ? clearScheduledSnoozesById(attributes, [snoozeId]) + : clearUnscheduledSnooze(attributes) + ).concat(snoozeSchedule), muteAll: false, }; @@ -2189,15 +2193,21 @@ export class RulesClient { ).then(() => this.updateSnoozedUntilTime({ id })); } - public async unsnooze({ id }: { id: string }): Promise { + public async unsnooze({ + id, + scheduleIds, + }: { + id: string; + scheduleIds?: string[]; + }): Promise { return await retryIfConflicts( this.logger, `rulesClient.unsnooze('${id}')`, - async () => await this.unsnoozeWithOCC({ id }) + async () => await this.unsnoozeWithOCC({ id, scheduleIds }) ); } - private async unsnoozeWithOCC({ id }: { id: string }) { + private async unsnoozeWithOCC({ id, scheduleIds }: { id: string; scheduleIds?: string[] }) { const { attributes, version } = await this.unsecuredSavedObjectsClient.get( 'alert', id @@ -2236,10 +2246,12 @@ export class RulesClient { this.ruleTypeRegistry.ensureRuleTypeEnabled(attributes.alertTypeId); const updateAttributes = this.updateMeta({ - snoozeSchedule: clearUnscheduledSnooze(attributes), - muteAll: false, + snoozeSchedule: scheduleIds + ? clearScheduledSnoozesById(attributes, scheduleIds) + : clearCurrentActiveSnooze(attributes), updatedBy: await this.getUserName(), updatedAt: new Date().toISOString(), + ...(!scheduleIds ? { muteAll: false } : {}), }); const updateOptions = { version }; @@ -2881,7 +2893,28 @@ function parseDate(dateString: string | undefined, propertyName: string, default } function clearUnscheduledSnooze(attributes: { snoozeSchedule?: RuleSnooze }) { + // Clear any snoozes that have no ID property. These are "simple" snoozes created with the quick UI, e.g. snooze for 3 days starting now return attributes.snoozeSchedule ? attributes.snoozeSchedule.filter((s) => typeof s.id !== 'undefined') : []; } + +function clearScheduledSnoozesById(attributes: { snoozeSchedule?: RuleSnooze }, ids: string[]) { + return attributes.snoozeSchedule + ? attributes.snoozeSchedule.filter((s) => s.id && !ids.includes(s.id)) + : []; +} + +function clearCurrentActiveSnooze(attributes: { snoozeSchedule?: RuleSnooze; muteAll: boolean }) { + // First attempt to cancel a simple (unscheduled) snooze + const clearedUnscheduledSnoozes = clearUnscheduledSnooze(attributes); + // Now clear any scheduled snoozes that are currently active and never recur + const activeSnoozes = getActiveSnoozes(attributes); + const activeSnoozeIds = activeSnoozes?.map((s) => s.id) ?? []; + const clearedNonRecurringActiveSnoozes = clearedUnscheduledSnoozes.filter((s) => { + if (!activeSnoozeIds.includes(s.id!)) return true; + // Check if this is a recurring snooze, and return true if so + if (s.rRule.freq && s.rRule.count !== 1) return true; + }); + return clearedNonRecurringActiveSnoozes; +} diff --git a/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx b/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx index 7a335964d5ccc..cf39561a5037b 100644 --- a/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx +++ b/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx @@ -11,7 +11,7 @@ import { uniqueId } from 'lodash'; import React, { useState } from 'react'; import { useHistory, useLocation } from 'react-router-dom'; import { QuerySuggestion } from '@kbn/unified-search-plugin/public'; -import { esKuery } from '@kbn/data-plugin/public'; +import { fromKueryExpression, toElasticsearchQuery } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/public'; import { useApmPluginContext } from '../../../context/apm_plugin/use_apm_plugin_context'; import { useLegacyUrlParams } from '../../../context/url_params_context/use_url_params'; @@ -29,8 +29,8 @@ interface State { } function convertKueryToEsQuery(kuery: string, dataView: DataView) { - const ast = esKuery.fromKueryExpression(kuery); - return esKuery.toElasticsearchQuery(ast, dataView); + const ast = fromKueryExpression(kuery); + return toElasticsearchQuery(ast, dataView); } export function KueryBar(props: { diff --git a/x-pack/plugins/apm/server/routes/rum_client/__snapshots__/queries.test.ts.snap b/x-pack/plugins/apm/server/routes/rum_client/__snapshots__/queries.test.ts.snap index 5931582340943..52c4c4b1d0333 100644 --- a/x-pack/plugins/apm/server/routes/rum_client/__snapshots__/queries.test.ts.snap +++ b/x-pack/plugins/apm/server/routes/rum_client/__snapshots__/queries.test.ts.snap @@ -1,78 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`rum client dashboard queries fetches client metrics 1`] = ` -Object { - "apm": Object { - "events": Array [ - "transaction", - ], - }, - "body": Object { - "aggs": Object { - "hasFetchStartField": Object { - "aggs": Object { - "backEnd": Object { - "percentiles": Object { - "field": "transaction.marks.agent.timeToFirstByte", - "hdr": Object { - "number_of_significant_value_digits": 3, - }, - "percents": Array [ - 50, - ], - }, - }, - "totalPageLoadDuration": Object { - "percentiles": Object { - "field": "transaction.duration.us", - "hdr": Object { - "number_of_significant_value_digits": 3, - }, - "percents": Array [ - 50, - ], - }, - }, - }, - "filter": Object { - "exists": Object { - "field": "transaction.marks.navigationTiming.fetchStart", - }, - }, - }, - }, - "query": Object { - "bool": Object { - "filter": Array [ - Object { - "range": Object { - "@timestamp": Object { - "format": "epoch_millis", - "gte": 0, - "lte": 50000, - }, - }, - }, - Object { - "term": Object { - "transaction.type": "page-load", - }, - }, - Object { - "term": Object { - "service.environment": "staging", - }, - }, - ], - "must_not": Array [], - }, - }, - "size": 0, - "track_total_hits": true, - }, -} -`; - exports[`rum client dashboard queries fetches long task metrics 1`] = ` Object { "apm": Object { @@ -464,4 +391,4 @@ Object { "size": 0, }, } -`; +`; \ No newline at end of file diff --git a/x-pack/plugins/apm/server/routes/rum_client/get_client_metrics.ts b/x-pack/plugins/apm/server/routes/rum_client/get_client_metrics.ts deleted file mode 100644 index 40352db9f18a6..0000000000000 --- a/x-pack/plugins/apm/server/routes/rum_client/get_client_metrics.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { getRumPageLoadTransactionsProjection } from '../../projections/rum_page_load_transactions'; -import { mergeProjection } from '../../projections/util/merge_projection'; -import { SetupUX } from './route'; -import { - TRANSACTION_TIME_TO_FIRST_BYTE, - TRANSACTION_DURATION, -} from '../../../common/elasticsearch_fieldnames'; - -export async function getClientMetrics({ - setup, - urlQuery, - percentile = 50, - start, - end, -}: { - setup: SetupUX; - urlQuery?: string; - percentile?: number; - start: number; - end: number; -}) { - const projection = getRumPageLoadTransactionsProjection({ - setup, - urlQuery, - checkFetchStartFieldExists: false, - start, - end, - }); - - const params = mergeProjection(projection, { - body: { - size: 0, - track_total_hits: true, - aggs: { - hasFetchStartField: { - filter: { - exists: { field: 'transaction.marks.navigationTiming.fetchStart' }, - }, - aggs: { - totalPageLoadDuration: { - percentiles: { - field: TRANSACTION_DURATION, - percents: [percentile], - hdr: { - number_of_significant_value_digits: 3, - }, - }, - }, - backEnd: { - percentiles: { - field: TRANSACTION_TIME_TO_FIRST_BYTE, - percents: [percentile], - hdr: { - number_of_significant_value_digits: 3, - }, - }, - }, - }, - }, - }, - }, - }); - - const { apmEventClient } = setup; - const response = await apmEventClient.search('get_client_metrics', params); - const { - hasFetchStartField: { backEnd, totalPageLoadDuration }, - } = response.aggregations!; - - const pkey = percentile.toFixed(1); - - const totalPageLoadDurationValue = totalPageLoadDuration.values[pkey] ?? 0; - const totalPageLoadDurationValueMs = totalPageLoadDurationValue / 1000; // Microseconds to milliseconds - const backendValue = backEnd.values[pkey] ?? 0; - - return { - pageViews: { value: response.hits.total.value ?? 0 }, - totalPageLoadDuration: { value: totalPageLoadDurationValueMs }, - backEnd: { value: backendValue }, - frontEnd: { value: totalPageLoadDurationValueMs - backendValue }, - }; -} diff --git a/x-pack/plugins/apm/server/routes/rum_client/queries.test.ts b/x-pack/plugins/apm/server/routes/rum_client/queries.test.ts index 43c115c75567c..a3725b0500c5f 100644 --- a/x-pack/plugins/apm/server/routes/rum_client/queries.test.ts +++ b/x-pack/plugins/apm/server/routes/rum_client/queries.test.ts @@ -9,7 +9,6 @@ import { SearchParamsMock, inspectSearchParams, } from '../../utils/test_helpers'; -import { getClientMetrics } from './get_client_metrics'; import { getPageViewTrends } from './get_page_view_trends'; import { getPageLoadDistribution } from './get_page_load_distribution'; import { getLongTaskMetrics } from './get_long_task_metrics'; @@ -21,20 +20,6 @@ describe('rum client dashboard queries', () => { mock.teardown(); }); - it('fetches client metrics', async () => { - mock = await inspectSearchParams( - (setup) => - getClientMetrics({ - setup, - start: 0, - end: 50000, - }), - { uiFilters: { environment: 'staging' } } - ); - - expect(mock.params).toMatchSnapshot(); - }); - it('fetches page view trends', async () => { mock = await inspectSearchParams( (setup) => diff --git a/x-pack/plugins/apm/server/routes/rum_client/route.ts b/x-pack/plugins/apm/server/routes/rum_client/route.ts index b1312822aaaff..d7911ef4a0206 100644 --- a/x-pack/plugins/apm/server/routes/rum_client/route.ts +++ b/x-pack/plugins/apm/server/routes/rum_client/route.ts @@ -7,7 +7,6 @@ import * as t from 'io-ts'; import { Logger } from '@kbn/core/server'; import { setupRequest, Setup } from '../../lib/helpers/setup_request'; -import { getClientMetrics } from './get_client_metrics'; import { getLongTaskMetrics } from './get_long_task_metrics'; import { getPageLoadDistribution } from './get_page_load_distribution'; import { getPageViewTrends } from './get_page_view_trends'; @@ -57,36 +56,6 @@ const uxQueryRt = t.intersection([ t.partial({ urlQuery: t.string, percentile: t.string }), ]); -const rumClientMetricsRoute = createApmServerRoute({ - endpoint: 'GET /internal/apm/ux/client-metrics', - params: t.type({ - query: uxQueryRt, - }), - options: { tags: ['access:apm'] }, - handler: async ( - resources - ): Promise<{ - pageViews: { value: number }; - totalPageLoadDuration: { value: number }; - backEnd: { value: number }; - frontEnd: { value: number }; - }> => { - const setup = await setupUXRequest(resources); - - const { - query: { urlQuery, percentile, start, end }, - } = resources.params; - - return getClientMetrics({ - setup, - urlQuery, - percentile: percentile ? Number(percentile) : undefined, - start, - end, - }); - }, -}); - const rumPageLoadDistributionRoute = createApmServerRoute({ endpoint: 'GET /internal/apm/ux/page-load-distribution', params: t.type({ @@ -270,7 +239,6 @@ async function setupUXRequest( } export const rumRouteRepository = { - ...rumClientMetricsRoute, ...rumPageLoadDistributionRoute, ...rumPageLoadDistBreakdownRoute, ...rumPageViewsTrendRoute, diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts index 2d8dab316ede2..a69ecb724a641 100644 --- a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts +++ b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts @@ -8,7 +8,7 @@ import { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; import type { PaletteOutput } from '@kbn/coloring'; import { Filter as DataFilter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { SavedObjectReference } from '@kbn/core/types'; import { getQueryFilters } from '../../../common/lib/build_embeddable_filters'; import { ExpressionValueFilter, EmbeddableInput, TimeRange as TimeRangeArg } from '../../../types'; diff --git a/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts b/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts index 6b8ef6e6ccdee..d726cc6db6e3d 100644 --- a/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts +++ b/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts @@ -8,7 +8,7 @@ import { buildQueryFilter, Filter } from '@kbn/es-query'; import dateMath from '@kbn/datemath'; import { maxBy, minBy } from 'lodash'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { ExpressionValueFilter } from '../../types'; // @ts-expect-error untyped local import { buildBoolArray } from './build_bool_array'; diff --git a/x-pack/plugins/canvas/public/functions/timelion.ts b/x-pack/plugins/canvas/public/functions/timelion.ts index f457bad07f92e..ee3a9ca7c0351 100644 --- a/x-pack/plugins/canvas/public/functions/timelion.ts +++ b/x-pack/plugins/canvas/public/functions/timelion.ts @@ -9,7 +9,7 @@ import { flatten } from 'lodash'; import moment from 'moment-timezone'; import { i18n } from '@kbn/i18n'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { ExpressionFunctionDefinition, DatatableRow } from '@kbn/expressions-plugin/public'; import { fetch } from '../../common/lib/fetch'; // @ts-expect-error untyped local diff --git a/x-pack/plugins/canvas/types/embeddables.ts b/x-pack/plugins/canvas/types/embeddables.ts index b548a2f0627a0..92e66b1e4e7a4 100644 --- a/x-pack/plugins/canvas/types/embeddables.ts +++ b/x-pack/plugins/canvas/types/embeddables.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { Filter } from '@kbn/es-query'; import { EmbeddableInput as Input } from '@kbn/embeddable-plugin/common'; diff --git a/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts b/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts index 52863d5dd8d1f..e99d9a8adc547 100644 --- a/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts +++ b/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts @@ -6,7 +6,7 @@ */ import { Plugin } from 'unified'; -import type { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { LENS_ID } from './constants'; export interface LensSerializerProps { diff --git a/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts b/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts index a91970bc97295..96d1f478c19aa 100644 --- a/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts +++ b/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts @@ -12,7 +12,7 @@ import remarkStringify from 'remark-stringify'; import unified from 'unified'; import { SerializableRecord } from '@kbn/utility-types'; -import type { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { LENS_ID, LensParser, LensSerializer } from './lens'; import { TimelineSerializer, TimelineParser } from './timeline'; diff --git a/x-pack/plugins/cloud_security_posture/kibana.json b/x-pack/plugins/cloud_security_posture/kibana.json index ec1452310bfe3..123e1e6ccf0e8 100755 --- a/x-pack/plugins/cloud_security_posture/kibana.json +++ b/x-pack/plugins/cloud_security_posture/kibana.json @@ -10,6 +10,6 @@ "description": "The cloud security posture plugin", "server": true, "ui": true, - "requiredPlugins": ["navigation", "data", "fleet", "unifiedSearch", "taskManager", "security"], + "requiredPlugins": ["navigation", "data", "fleet", "unifiedSearch", "taskManager", "security", "charts"], "requiredBundles": ["kibanaReact"] } diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx index 9fd7806d27665..98a3b140aa233 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx @@ -25,6 +25,7 @@ import { statusColors } from '../../../common/constants'; import type { PostureTrend, Stats } from '../../../../common/types'; import { CompactFormattedNumber } from '../../../components/compact_formatted_number'; import { RULE_FAILED, RULE_PASSED } from '../../../../common/constants'; +import { useKibana } from '../../../common/hooks/use_kibana'; interface CloudPostureScoreChartProps { trend: PostureTrend[]; @@ -44,18 +45,26 @@ const ScoreChart = ({ { label: RULE_PASSED, value: totalPassed }, { label: RULE_FAILED, value: totalFailed }, ]; + const { + services: { charts }, + } = useKibana(); return ( ({ const ComplianceTrendChart = ({ trend }: { trend: PostureTrend[] }) => { const epochTimeTrend = trend.map(convertTrendToEpochTime); + const { + services: { charts }, + } = useKibana(); return ( { const Wrapper = ({ data = dataPluginMock.createStartContract(), unifiedSearch = unifiedSearchPluginMock.createStartContract(), + charts = chartPluginMock.createStartContract(), }: { data: DataPublicPluginStart; unifiedSearch: UnifiedSearchPublicPluginStart; + charts: ChartsPluginStart; }) => ( - + ); @@ -44,6 +48,7 @@ describe.skip('', () => { it("renders the success state component when 'latest findings' DataView exists and request status is 'success'", async () => { const data = dataPluginMock.createStartContract(); const unifiedSearch = unifiedSearchPluginMock.createStartContract(); + const charts = chartPluginMock.createStartContract(); const source = await data.search.searchSource.create(); (useCisKubernetesIntegration as jest.Mock).mockImplementation(() => ({ @@ -60,7 +65,7 @@ describe.skip('', () => { }), } as UseQueryResult); - render(); + render(); expect(await screen.findByTestId(TEST_SUBJECTS.FINDINGS_CONTAINER)).toBeInTheDocument(); }); diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/latest_findings_container.test.tsx b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/latest_findings_container.test.tsx index fb74aba060892..3e9fd0941495e 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/latest_findings_container.test.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/latest_findings_container.test.tsx @@ -21,6 +21,7 @@ import { RisonObject } from 'rison-node'; import { buildEsQuery } from '@kbn/es-query'; import { getPaginationQuery } from '../utils'; import { FindingsEsPitContext } from '../es_pit/findings_es_pit_context'; +import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; jest.mock('../../../common/api/use_latest_findings_data_view'); jest.mock('../../../common/api/use_cis_kubernetes_integration'); @@ -64,6 +65,7 @@ describe('', () => { deps={{ data: dataMock, unifiedSearch: unifiedSearchPluginMock.createStartContract(), + charts: chartPluginMock.createStartContract(), }} > diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/use_latest_findings.ts b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/use_latest_findings.ts index 90be856b82d06..924ec7c3d4963 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/use_latest_findings.ts +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings/use_latest_findings.ts @@ -48,6 +48,7 @@ const FIELDS_WITHOUT_KEYWORD_MAPPING = new Set([ '@timestamp', 'resource.sub_type', 'resource.name', + 'resource.id', 'rule.name', ]); diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/resource_findings/use_resource_findings.ts b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/resource_findings/use_resource_findings.ts index 2bd1b49aada2d..5ab16566b9100 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/resource_findings/use_resource_findings.ts +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/resource_findings/use_resource_findings.ts @@ -43,7 +43,7 @@ const getResourceFindingsQuery = ({ ...query, bool: { ...query?.bool, - filter: [...(query?.bool?.filter || []), { term: { 'resource_id.keyword': resourceId } }], + filter: [...(query?.bool?.filter || []), { term: { 'resource.id': resourceId } }], }, }, pit: { id: pitId }, diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_layout.tsx b/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_layout.tsx index d735d02e1f797..4da84b23847a0 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_layout.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_layout.tsx @@ -67,7 +67,7 @@ export const getExpandColumn = ({ export const getFindingsColumns = (): Array> => [ { - field: 'resource_id', + field: 'resource.id', name: ( > = ({ core = coreMock.createStart(), - deps = { data: dataPluginMock.createStartContract() }, + deps = { + data: dataPluginMock.createStartContract(), + unifiedSearch: unifiedSearchPluginMock.createStartContract(), + charts: chartPluginMock.createStartContract(), + }, params = coreMock.createAppMountParameters(), children, } = {}) => { diff --git a/x-pack/plugins/cloud_security_posture/public/types.ts b/x-pack/plugins/cloud_security_posture/public/types.ts index 54cd9e22eb45f..f5fbb2766e6b9 100755 --- a/x-pack/plugins/cloud_security_posture/public/types.ts +++ b/x-pack/plugins/cloud_security_posture/public/types.ts @@ -5,8 +5,9 @@ * 2.0. */ -import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; +import type { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; import type { DataPublicPluginSetup, DataPublicPluginStart } from '@kbn/data-plugin/public'; +import type { ChartsPluginStart } from '@kbn/charts-plugin/public'; // eslint-disable-next-line @typescript-eslint/no-empty-interface export interface CspClientPluginSetup {} @@ -24,5 +25,6 @@ export interface CspClientPluginStartDeps { // required data: DataPublicPluginStart; unifiedSearch: UnifiedSearchPublicPluginStart; + charts: ChartsPluginStart; // optional } diff --git a/x-pack/plugins/cloud_security_posture/server/create_indices/latest_findings_mapping.ts b/x-pack/plugins/cloud_security_posture/server/create_indices/latest_findings_mapping.ts index eb7ae78b61624..f26aadcd62deb 100644 --- a/x-pack/plugins/cloud_security_posture/server/create_indices/latest_findings_mapping.ts +++ b/x-pack/plugins/cloud_security_posture/server/create_indices/latest_findings_mapping.ts @@ -55,11 +55,6 @@ export const latestFindingsMapping: MappingTypeMapping = { id: { type: 'keyword', ignore_above: 1024, - fields: { - text: { - type: 'text', - }, - }, }, name: { type: 'keyword', @@ -85,16 +80,6 @@ export const latestFindingsMapping: MappingTypeMapping = { }, }, }, - resource_id: { - // deprecated - the new field is resource.id - type: 'text', - fields: { - keyword: { - ignore_above: 1024, - type: 'keyword', - }, - }, - }, rule: { properties: { name: { diff --git a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx index abc2c8b33e5de..c529eb11d0855 100644 --- a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx +++ b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.test.tsx @@ -5,11 +5,10 @@ * 2.0. */ -import type { Filter, RangeFilter } from '@kbn/es-query'; +import { Filter, RangeFilter, FilterStateStore, Query, TimeRange } from '@kbn/es-query'; import { EmbeddableToDashboardDrilldown } from './embeddable_to_dashboard_drilldown'; import { AbstractDashboardDrilldownConfig as Config } from '../abstract_dashboard_drilldown'; import { savedObjectsServiceMock } from '@kbn/core/public/mocks'; -import { FilterStateStore, Query, TimeRange } from '@kbn/data-plugin/common'; import { ApplyGlobalFilterActionContext } from '@kbn/unified-search-plugin/public'; import { DashboardAppLocatorDefinition, diff --git a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx index 2849ef4a580fa..e18a8a37cf22e 100644 --- a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx +++ b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx @@ -4,17 +4,11 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { type Filter, isFilters, isFilterPinned } from '@kbn/es-query'; +import { type Filter, isFilters, isFilterPinned, Query, TimeRange } from '@kbn/es-query'; import type { KibanaLocation } from '@kbn/share-plugin/public'; import { DashboardAppLocatorParams, cleanEmptyKeys } from '@kbn/dashboard-plugin/public'; import { setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public'; -import { - APPLY_FILTER_TRIGGER, - isQuery, - isTimeRange, - Query, - TimeRange, -} from '@kbn/data-plugin/public'; +import { APPLY_FILTER_TRIGGER, isQuery, isTimeRange } from '@kbn/data-plugin/public'; import { extractTimeRange } from '@kbn/es-query'; import { ApplyGlobalFilterActionContext } from '@kbn/unified-search-plugin/public'; import { IEmbeddable, EmbeddableInput } from '@kbn/embeddable-plugin/public'; diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx index 34885090d643f..7130841d0a6ac 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx @@ -10,7 +10,8 @@ import { Subscription } from 'rxjs'; import { debounce } from 'lodash'; import { EuiSuperDatePicker, OnRefreshProps } from '@elastic/eui'; -import { TimeHistoryContract, TimeRange, UI_SETTINGS } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { TimeHistoryContract, UI_SETTINGS } from '@kbn/data-plugin/public'; import { useUrlState } from '../../util/url_state'; import { useDataVisualizerKibana } from '../../../kibana_context'; diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/link_card/link_card.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/link_card/link_card.tsx index 4d5b5a8154e72..855465eeab0c8 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/link_card/link_card.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/link_card/link_card.tsx @@ -71,10 +71,10 @@ export const LinkCard: FC = ({ )} - +

{title}

 - +

{description}

 diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx index 64b0097401ef6..387c41f2b44f9 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx @@ -9,7 +9,8 @@ import React, { FC, useState, useEffect } from 'react'; import moment from 'moment'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiFlexGroup, EuiFlexItem, EuiCard, EuiIcon } from '@elastic/eui'; -import { TimeRange, RefreshInterval } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { RefreshInterval } from '@kbn/data-plugin/public'; import { FindFileStructureResponse } from '@kbn/file-upload-plugin/common'; import type { FileUploadPluginStart } from '@kbn/file-upload-plugin/public'; import { flatten } from 'lodash'; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx index d892b5f159434..0b4103687bbde 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx @@ -20,8 +20,8 @@ import { } from '@elastic/eui'; import { Required } from 'utility-types'; import { i18n } from '@kbn/i18n'; -import { Filter } from '@kbn/es-query'; -import { Query, generateFilters } from '@kbn/data-plugin/public'; +import { Filter, Query } from '@kbn/es-query'; +import { generateFilters } from '@kbn/data-plugin/public'; import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; import { FullTimeRangeSelector } from '../full_time_range_selector'; import { usePageUrlState, useUrlState } from '../../../common/util/url_state'; @@ -287,7 +287,7 @@ export const IndexDataVisualizerView: FC = (dataVi field, values, operation, - String(currentDataView.id) + currentDataView ); if (newFilters) { data.query.filterManager.addFilters(newFilters); @@ -398,8 +398,8 @@ export const IndexDataVisualizerView: FC = (dataVi
- -

{currentDataView.title}

+ +

{currentDataView.title}

 ; +} + +export const AddCustomSourceLogic = kea< + MakeLogicType +>({ + path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], + actions: { + fetchSource: true, + fetchSourceError: (code, error) => ({ code, error }), + fetchSourceSuccess: (customSource) => customSource, + }, + reducers: () => ({ + sourceApiStatus: [ + { + status: 'IDLE', + }, + { + fetchSource: () => ({ + status: 'PENDING', + }), + fetchSourceError: (_, error) => ({ + status: 'ERROR', + error, + }), + fetchSourceSuccess: (_, data) => ({ + status: 'SUCCESS', + data, + }), + }, + ], + }), + listeners: ({ actions }) => ({ + fetchSource: async () => { + clearFlashMessages(); + + try { + const response = await HttpLogic.values.http.post('/api/source'); + actions.fetchSourceSuccess(response); + } catch (e) { + flashAPIErrors(e); + actions.fetchSourceError(e.code, e.message); + } + }, + }), +}); +``` + +The types used above can be found in our [common Enterprise Search types file](common/types/api.ts). While the above assumes a single, idempotent API, this approach can be easily extended to use a dictionary approach: +```typescript +reducers: () => ({ + sourceApiStatus: [ + { + }, + { + fetchSource: (state, id) => ({...state, + id: { + status: 'PENDING', + data: state[id]?.data, + }}), + fetchSourceError: (_, ({id, error})) => ({...state, + id: { + status: 'ERROR', + error, + }}), + fetchSourceSuccess: (_, ({id, data})) => ({...state, id: { + status: 'SUCCESS', + data, + }}), + }, + ], + }), +``` +## Import actions and values from API logic files into component and view logic. + +Once you have an API interactions file set up, components and other Kea logic files can import the values from those files to build their own logic. Use the Kea 'connect' functionality to do this, as the auto-connect functionality has a few bugs and was removed in Kea 3.0. This allows you to read the status and value of an API, react to any API events, and abstract those APIs away from the components. Those components can now become more functional and reactive to the current state of the application, rather than to directly responding to API events. + +You can connect logic files by adding a `connect` property to your Kea logic function, specifying the specific actions and values you want to import into your own logic. You can be selective there, and don't need to import all actions and values--only the ones you'll actually use. You can then access those actions and values directly under their own name in your new logic function. + +```typescript +export const AddCustomSourceLogic = kea< + MakeLogicType +>({ + connect: { + actions: [AddCustomSourceApiLogic, ['addSource', 'addSourceSuccess', 'addSourceError']], + values: [AddCustomSourceApiLogic, ['sourceApi']], + }, + path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], + actions: { + createContentSource: true, + setCustomSourceNameValue: (customSourceNameValue) => customSourceNameValue, + setNewCustomSource: (data) => data, + }, + reducers: ({ props }) => ({ + customSourceNameValue: [ + props.initialValue || '', + { + setCustomSourceNameValue: (_, customSourceNameValue) => customSourceNameValue, + }, + ], + newCustomSource: [ + undefined, + { + setNewCustomSource: (_, newCustomSource) => newCustomSource, + }, + ], + }), + listeners: ({ actions, values, props }) => ({ + createContentSource: () => { + const { customSourceNameValue } = values; + const { baseServiceType } = props; + actions.addSource(customSourceNameValue, baseServiceType); + }, + addSourceSuccess: (customSource: CustomSource) => { + actions.setNewCustomSource(customSource); + }, + }), + selectors: { + buttonLoading: [ + (selectors) => [selectors.sourceApi], + (apiStatus) => apiStatus?.status === 'PENDING', + ], + }, +}); +``` + +You'll have to add the imported the actions and values types you're already using for your function, preferably by importing the types off the imported logic. Like so: +```typescript +export interface AddCustomSourceActions { + addSource: AddCustomSourceApiActions['addSource']; + addSourceSuccess: AddCustomSourceApiActions['addSourceSuccess']; +} +``` +## Keep your logic files small + +Using the above methods, you can keep your logic files small and isolated. Keep API calls separate from view and component logic. Keep the amount of logic you're processing limited per file. If your logic file starts exceeding about 150 lines of code, you should start thinking about splitting it up into separate chunks, if possible. + +Splitting up logic helps keep your application logic manageable and somewhat isolated, it helps keep your logic files testable, and it helps you understand what is happening in each logic file. + +## When connecting logic files, be explicit + +Kea has a feature where it will auto-connect logic files when you use actions and values from one file in another. This works, but has led to bugs in the past. Because it's generally better to be explicit than implicit, we prefer making these links explicit as well. Use the 'connect' feature on a Kea logic function to connect two different logics together. See above for an example. diff --git a/x-pack/plugins/enterprise_search/README.md b/x-pack/plugins/enterprise_search/README.md index 1a54f8c23750b..74391a9a96f5d 100644 --- a/x-pack/plugins/enterprise_search/README.md +++ b/x-pack/plugins/enterprise_search/README.md @@ -27,15 +27,17 @@ Don't forget to read Kibana's [contributing documentation](https://github.com/el ### Kea -Enterprise Search uses [Kea.js](https://github.com/keajs/kea) to manage our React/Redux state for us. Kea state is handled in our `*Logic` files and exposes [values](https://kea.js.org/docs/guide/concepts#values) and [actions](https://kea.js.org/docs/guide/concepts#actions) for our components to get and set state with. +Enterprise Search uses [Kea.js](https://github.com/keajs/kea) to manage our React/Redux state for us. Kea state is handled in our `*Logic` files and exposes [values](https://v2.keajs.org/docs/guide/concepts#values) and [actions](https://v2.keajs.org/docs/guide/concepts#actions) for our components to get and set state with. + +For extended guidelines, please check [KEA.md](KEA.md) #### Advanced Kea usage -For the most part, we stick to the functionality described in Kea's [core concepts](https://kea.js.org/docs/guide/concepts). However, in some files, we also take advantage of [props](https://kea.js.org/docs/guide/additional#props) and [events](https://kea.js.org/docs/guide/additional#events), as well as [manually mounting](https://kea.js.org/docs/guide/advanced#mounting-and-unmounting) some shared logic files on plugin init outside of React. +For the most part, we stick to the functionality described in Kea's [core concepts](https://v2.keajs.org/docs/guide/concepts). However, in some files, we also take advantage of [props](https://v2.keajs.org/docs/guide/additional#props) and [events](https://v2.keajs.org/docs/guide/additional#events), as well as [manually mounting](https://v2.keajs.org/docs/guide/advanced#mounting-and-unmounting) some shared logic files on plugin init outside of React. #### Debugging Kea -To debug Kea state in-browser, Kea recommends [Redux Devtools](https://kea.js.org/docs/guide/debugging). To facilitate debugging, we use the [path](https://kea.js.org/docs/guide/debugging/#setting-the-path-manually) key with `snake_case`d paths. The path key should always end with the logic filename (e.g. `['enterprise_search', 'some_logic']`) to make it easy for devs to quickly find/jump to files via IDE tooling. +To debug Kea state in-browser, Kea recommends [Redux Devtools](https://v2.keajs.org/docs/guide/debugging). To facilitate debugging, we use the [path](https://v2.keajs.org/docs/guide/debugging/#setting-the-path-manually) key with `snake_case`d paths. The path key should always end with the logic filename (e.g. `['enterprise_search', 'some_logic']`) to make it easy for devs to quickly find/jump to files via IDE tooling. ## Testing diff --git a/x-pack/plugins/enterprise_search/common/types/api.ts b/x-pack/plugins/enterprise_search/common/types/api.ts new file mode 100644 index 0000000000000..2ba225bd19223 --- /dev/null +++ b/x-pack/plugins/enterprise_search/common/types/api.ts @@ -0,0 +1,40 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/** + * These types track an API call's status and result + * Each Status string corresponds to a possible status in a request's lifecycle + */ + +export type Status = 'IDLE' | 'PENDING' | 'SUCCESS' | 'ERROR'; + +export interface HttpError { + code: number; + message?: string; +} + +export interface ApiSuccess { + status: 'SUCCESS'; + data: T; +} + +export interface ApiPending { + status: 'PENDING'; + data?: T; +} + +export interface ApiIdle { + status: 'IDLE'; + data?: T; +} + +export interface ApiError { + status: Status; + error: HttpError; +} + +export type ApiStatus = ApiSuccess | ApiPending | ApiIdle | ApiError; diff --git a/x-pack/plugins/enterprise_search/jest.sh b/x-pack/plugins/enterprise_search/jest.sh old mode 100644 new mode 100755 diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.test.ts index ec60bf5ae8a8e..a7a3523c7ebf3 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.test.ts @@ -347,9 +347,9 @@ describe('EngineCreationLogic', () => { jest.clearAllMocks(); }); - it('GETs to /internal/enterprise_search/indices', () => { + it('GETs to /internal/enterprise_search/search_indices', () => { EngineCreationLogic.actions.loadIndices(); - expect(http.get).toHaveBeenCalledWith('/internal/enterprise_search/indices'); + expect(http.get).toHaveBeenCalledWith('/internal/enterprise_search/search_indices'); }); it('calls onLoadIndicesSuccess with payload on load is successful', async () => { diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.ts index 2bc7f1f977129..4b1a96a25412b 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/engine_creation_logic.ts @@ -164,7 +164,7 @@ export const EngineCreationLogic = kea { const { http } = HttpLogic.values; try { - const indices = await http.get('/internal/enterprise_search/indices'); + const indices = await http.get('/internal/enterprise_search/search_indices'); actions.onLoadIndicesSuccess(indices as ElasticsearchIndex[]); } catch (e) { flashAPIErrors(e); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx new file mode 100644 index 0000000000000..f47be4269edcc --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { shallow } from 'enzyme'; + +import { MethodApi } from './method_api'; +import { NewSearchIndexTemplate } from './new_search_index_template'; + +describe('API ingestion method', () => { + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('renders API ingestion method tab', () => { + const wrapper = shallow(); + const template = wrapper.find(NewSearchIndexTemplate); + + expect(template.prop('type')).toEqual('api'); + }); +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx index 699b84327978c..a68c33db0eae5 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx @@ -8,76 +8,34 @@ /** * TODO: * - Need to add documentation URLs (search for `#`s) - * - Need to implement the logic for the attaching search engines functionality */ import React from 'react'; -import { useValues } from 'kea'; - -import { EuiCodeBlock, EuiLink, EuiPanel, EuiSpacer, EuiText, EuiTitle } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; +import { EuiText } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { getEnterpriseSearchUrl } from '../../../shared/enterprise_search_url/external_url'; - -import { DOCUMENTS_API_JSON_EXAMPLE } from './constants'; -import { NewSearchIndexLogic } from './new_search_index_logic'; import { NewSearchIndexTemplate } from './new_search_index_template'; export const MethodApi: React.FC = () => { - const { name } = useValues(NewSearchIndexLogic); - const apiKey = 1212312313; // TODO change this - - const searchIndexApiUrl = getEnterpriseSearchUrl('/api/ent/v1/search_indices/'); - return ( + } description={ - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.methodApi.description.clientLibrariesLink', - { - defaultMessage: 'client libraries', - } - )} - - ), - }} + defaultMessage="Provide a name and optionally select a language analyzer for your documents. An Elasticsearch index will be created. In the next step, well display API instructions." /> } docsUrl="#" type="api" - > - - -

- {i18n.translate('xpack.enterpriseSearch.content.newIndex.methodApi.endpointTitle', { - defaultMessage: 'Enter a name to preview your new API endpoint', - })} -

- - {name && ( - <> - - - {`\ -curl -X POST '${searchIndexApiUrl}${name}/document' \\ - -H 'Content-Type: application/json' \\ - -H 'Authorization: Bearer ${apiKey}' \\ - -d '${JSON.stringify(DOCUMENTS_API_JSON_EXAMPLE, null, 2)}' -`} - - - )} - - + /> ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx index 927f5e79ff2ff..36522002d7e88 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx @@ -21,6 +21,7 @@ import { NewSearchIndexTemplate } from './new_search_index_template'; export const MethodConnector: React.FC = () => { return ( { return ( { return ( { return ( { id: 'crawler', icon: 'globe', label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.crawler.label', { - defaultMessage: 'Web crawler', + defaultMessage: 'Use the web crawler', }), description: i18n.translate( 'xpack.enterpriseSearch.content.newIndex.buttonGroup.crawler.description', { - defaultMessage: 'Automatically index content from your website or knowlege base', - } - ), - }, - { - id: 'api', - icon: 'visVega', - label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.api.label', { - defaultMessage: 'API', - }), - description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.api.description', - { - defaultMessage: 'Use a variety of client libraries to add documents to your search index', + defaultMessage: 'Index content from your websites', } ), }, @@ -93,42 +74,42 @@ export const NewIndex: React.FC = () => { id: 'connector', icon: 'package', label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.connector.label', { - defaultMessage: 'Connector', + defaultMessage: 'Use a data integration', }), description: i18n.translate( 'xpack.enterpriseSearch.content.newIndex.buttonGroup.connector.description', { defaultMessage: - 'Ingest data from content sources like GitHub, Google Drive or SharePoint', + 'Index content frrom third-party services such as SharePoint and Google Drive', } ), }, { - id: 'elasticsearch', - icon: 'logoElasticsearch', - label: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.elasticsearch.label', - { - defaultMessage: 'Elasticsearch index', - } - ), + id: 'api', + icon: 'visVega', + label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.api.label', { + defaultMessage: 'Use the API', + }), description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.elasticsearch.description', + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.api.description', { - defaultMessage: 'Connect to an existing Elasticsearch index', + defaultMessage: 'Use a variety of client libraries to add documents to your search index', } ), }, { - id: 'json', - icon: 'document', - label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.json.label', { - defaultMessage: 'Paste or upload JSON', - }), + id: 'customIntegration', + icon: 'package', + label: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.customIntegration.label', + { + defaultMessage: 'Build a custom data integration', + } + ), description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.json.description', + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.customIntegration.description', { - defaultMessage: 'Manually upload JSON files', + defaultMessage: 'Clone the connector package repo and start customizing.', } ), }, @@ -150,37 +131,20 @@ export const NewIndex: React.FC = () => { ); - const CardLabel: React.FC = ({ title, description, icon }) => ( - - - - - - - -

{title}

- - - - - {description} - - ); - const SelectSearchIndexLayout = () => ( <> - - + +

{i18n.translate('xpack.enterpriseSearch.content.newIndex.selectSearchIndex.title', { - defaultMessage: 'Create a search index', + defaultMessage: 'Select an ingestion method', })}

- +

{i18n.translate( 'xpack.enterpriseSearch.content.newIndex.selectSearchIndex.description', @@ -195,32 +159,42 @@ export const NewIndex: React.FC = () => { {buttonGroupOptions.map((item) => ( - + handleMethodChange(item.id)} - checked={selectedMethod.id === item.id} - /> + hasShadow={false} + onClick={() => { + handleMethodChange(item.id); + }} + > + + + + + +

{item.label}

+ + + + +

{item.description}

+ + + + + +
+ +
+ + + ))} - - - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.selectSearchIndex.learnMore.buttonText', - { - defaultMessage: 'Learn more about search indices', - } - )} - diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts index 9c205274f9cf9..d12ab55a37f75 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts @@ -11,12 +11,9 @@ import { DEFAULT_LANGUAGE } from './constants'; import { NewSearchIndexLogic } from './new_search_index_logic'; const DEFAULT_VALUES = { - searchEngines: [], - searchEngineSelectOptions: [], rawName: '', name: '', language: DEFAULT_LANGUAGE, - selectedSearchEngines: [], }; describe('NewSearchIndexLogic', () => { diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts index b1626c90b3f59..f2034a8c4ce76 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts @@ -7,43 +7,26 @@ import { kea, MakeLogicType } from 'kea'; -import type { EuiComboBoxOptionOption } from '@elastic/eui'; - -import { Engine } from '../../../app_search/components/engine/types'; import { formatApiName } from '../../utils/format_api_name'; -import { SearchIndicesLogic, SearchIndicesValues } from '../search_indices/search_indices_logic'; - import { DEFAULT_LANGUAGE } from './constants'; -import { ISearchEngineOption } from './new_search_index_template'; -export interface NewSearchIndexValues extends Pick { - searchEngineSelectOptions: ISearchEngineOption[]; +export interface NewSearchIndexValues { rawName: string; name: string; language: string; - selectedSearchEngines: Array>; } export interface NewSearchIndexActions { setRawName(rawName: string): { rawName: string }; setLanguage(language: string): { language: string }; - setSelectedSearchEngineOptions(selectedSearchEngines: Array>): { - selectedSearchEngines: Array>; - }; } export const NewSearchIndexLogic = kea>({ path: ['enterprise_search', 'content', 'new_search_index'], - connect: { - values: [SearchIndicesLogic, ['searchEngines']], - }, actions: { setRawName: (rawName) => ({ rawName }), setLanguage: (language) => ({ language }), - setSelectedSearchEngineOptions: (selectedSearchEngines) => ({ - selectedSearchEngines, - }), }, reducers: { language: [ @@ -58,22 +41,8 @@ export const NewSearchIndexLogic = kea rawName, }, ], - selectedSearchEngines: [ - [], - { - setSelectedSearchEngineOptions: (_, { selectedSearchEngines }) => selectedSearchEngines, - }, - ], }, selectors: ({ selectors }) => ({ name: [() => [selectors.rawName], (rawName) => formatApiName(rawName)], - searchEngineSelectOptions: [ - () => [selectors.searchEngines], - (searchEngines) => - searchEngines.map((s: Engine) => ({ - label: s.name, - value: s, - })), - ], }), }); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx index b0e3adf3bdb71..1eb228aa876e0 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx @@ -17,7 +17,6 @@ import { useValues, useActions } from 'kea'; import { EuiButton, - EuiComboBox, EuiFieldText, EuiFlexGroup, EuiFlexItem, @@ -26,6 +25,7 @@ import { EuiPanel, EuiSelect, EuiSpacer, + EuiSteps, EuiText, EuiTitle, } from '@elastic/eui'; @@ -33,10 +33,11 @@ import { i18n } from '@kbn/i18n'; import { Engine } from '../../../app_search/components/engine/types'; -import { SUPPORTED_LANGUAGES, NEW_INDEX_TEMPLATE_TYPES } from './constants'; +import { SUPPORTED_LANGUAGES } from './constants'; import { NewSearchIndexLogic } from './new_search_index_logic'; export interface ISearchIndex { + title: React.ReactNode; description: React.ReactNode; docsUrl: string; type: string; @@ -50,14 +51,12 @@ export interface ISearchEngineOption { export const NewSearchIndexTemplate: React.FC = ({ children, + title, description, - type, onNameChange, }) => { - const { searchEngineSelectOptions, name, language, rawName, selectedSearchEngines } = - useValues(NewSearchIndexLogic); - const { setRawName, setLanguage, setSelectedSearchEngineOptions } = - useActions(NewSearchIndexLogic); + const { name, language, rawName } = useValues(NewSearchIndexLogic); + const { setRawName, setLanguage } = useActions(NewSearchIndexLogic); const handleNameChange = (e: ChangeEvent) => { setRawName(e.target.value); @@ -75,15 +74,7 @@ export const NewSearchIndexTemplate: React.FC = ({ -

- {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.title', - { - defaultMessage: 'New {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, - } - )} -

+

{title}

@@ -106,8 +97,17 @@ export const NewSearchIndexTemplate: React.FC = ({ label={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputLabel', { - defaultMessage: 'Name your {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, + defaultMessage: 'Index name', + } + )} + helpText={i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputHelpText', + { + defaultMessage: + 'Names cannot contain spaces or special characters. {indexName}', + values: { + indexName: name.length > 0 ? `Your index will be named: ${name}` : '', + }, } )} fullWidth @@ -116,8 +116,7 @@ export const NewSearchIndexTemplate: React.FC = ({ placeholder={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputPlaceholder', { - defaultMessage: 'Set a name for the {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, + defaultMessage: 'Set a name for your index', } )} fullWidth @@ -132,7 +131,13 @@ export const NewSearchIndexTemplate: React.FC = ({ label={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.languageInputLabel', { - defaultMessage: 'Language', + defaultMessage: 'Document language', + } + )} + helpText={i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.languageInputHelpText', + { + defaultMessage: 'Analyzers can be changed later, but may require a reindex', } )} > @@ -145,48 +150,107 @@ export const NewSearchIndexTemplate: React.FC = ({ - {searchEngineSelectOptions.length !== 0 && ( - - - { - setSelectedSearchEngineOptions(options); - }} - selectedOptions={selectedSearchEngines} - /> - - - )} {children} - - - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.createIndex.buttonText', - { - defaultMessage: 'Create search index', - } - )} - - + + + + {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.createIndex.buttonText', + { + defaultMessage: 'Create index', + } + )} + + + + + {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.viewDocumentation.linkText', + { + defaultMessage: 'View the documentation', + } + )} + + + + + + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.createIndex.content', + { + defaultMessage: + 'Provide a unique name for your index and select an optional language analyzer.', + } + )} +

+ + ), + status: 'incomplete', + }, + { + title: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.configureIngestion.title', + { + defaultMessage: 'Configure ingestion settings', + } + ), + titleSize: 'xs', + children: ( + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.configureIngestion.content', + { + defaultMessage: + 'Generate an API key and view the documentation for posting documents to the Elasticsearch API endpoint. Language clients are available for streamlined integration.', + } + )} +

+ + ), + status: 'incomplete', + }, + { + title: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.buildSearchExperience.title', + { + defaultMessage: 'Build a search experience', + } + ), + titleSize: 'xs', + children: ( + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.buildSearchExperience.content', + { + defaultMessage: + 'Connect your newly created Elasticsearch index to an App Search engine to build a cusomtizable search experience.', + } + )} +

+ + ), + status: 'incomplete', + }, + ]} + /> ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts new file mode 100644 index 0000000000000..a08d024e465ad --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts @@ -0,0 +1,155 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + LogicMounter, + mockFlashMessageHelpers, + mockHttpValues, +} from '../../../../../../__mocks__/kea_logic'; +import { sourceConfigData } from '../../../../../__mocks__/content_sources.mock'; + +import { nextTick } from '@kbn/test-jest-helpers'; + +import { itShowsServerErrorAsFlashMessage } from '../../../../../../test_helpers'; + +jest.mock('../../../../../app_logic', () => ({ + AppLogic: { values: { isOrganization: true } }, +})); +import { AppLogic } from '../../../../../app_logic'; + +import { AddCustomSourceApiLogic } from './add_custom_source_api_logic'; + +const DEFAULT_VALUES = { + sourceApi: { + status: 'IDLE', + }, +}; + +const MOCK_NAME = 'name'; + +describe('AddCustomSourceLogic', () => { + const { mount } = new LogicMounter(AddCustomSourceApiLogic); + const { http } = mockHttpValues; + const { clearFlashMessages } = mockFlashMessageHelpers; + + beforeEach(() => { + jest.clearAllMocks(); + mount({}); + }); + + it('has expected default values', () => { + expect(AddCustomSourceApiLogic.values).toEqual(DEFAULT_VALUES); + }); + + describe('listeners', () => { + beforeEach(() => { + mount(); + }); + + describe('organization context', () => { + describe('createContentSource', () => { + it('calls API and sets values', async () => { + const addSourceSuccessSpy = jest.spyOn( + AddCustomSourceApiLogic.actions, + 'addSourceSuccess' + ); + http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); + + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); + + expect(clearFlashMessages).toHaveBeenCalled(); + expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { + body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), + }); + await nextTick(); + expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); + }); + + it('submits a base service type for pre-configured sources', async () => { + const addSourceSuccessSpy = jest.spyOn( + AddCustomSourceApiLogic.actions, + 'addSourceSuccess' + ); + http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); + + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME, 'base_service_type'); + + expect(clearFlashMessages).toHaveBeenCalled(); + expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { + body: JSON.stringify({ + service_type: 'custom', + name: MOCK_NAME, + base_service_type: 'base_service_type', + }), + }); + await nextTick(); + expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); + }); + + itShowsServerErrorAsFlashMessage(http.post, () => { + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); + }); + }); + }); + + describe('account context routes', () => { + beforeEach(() => { + AppLogic.values.isOrganization = false; + }); + + describe('createContentSource', () => { + it('calls API and sets values', async () => { + const addSourceSuccessSpy = jest.spyOn( + AddCustomSourceApiLogic.actions, + 'addSourceSuccess' + ); + http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); + + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); + + expect(clearFlashMessages).toHaveBeenCalled(); + expect(http.post).toHaveBeenCalledWith( + '/internal/workplace_search/account/create_source', + { + body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), + } + ); + await nextTick(); + expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); + }); + + it('submits a base service type for pre-configured sources', async () => { + const addSourceSuccessSpy = jest.spyOn( + AddCustomSourceApiLogic.actions, + 'addSourceSuccess' + ); + http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); + + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME, 'base_service_type'); + + expect(clearFlashMessages).toHaveBeenCalled(); + expect(http.post).toHaveBeenCalledWith( + '/internal/workplace_search/account/create_source', + { + body: JSON.stringify({ + service_type: 'custom', + name: MOCK_NAME, + base_service_type: 'base_service_type', + }), + } + ); + await nextTick(); + expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); + }); + + itShowsServerErrorAsFlashMessage(http.post, () => { + AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); + }); + }); + }); + }); +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts new file mode 100644 index 0000000000000..4c4655a3882e0 --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts @@ -0,0 +1,80 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { kea, MakeLogicType } from 'kea'; + +import { ApiStatus, HttpError } from '../../../../../../../../common/types/api'; +import { flashAPIErrors, clearFlashMessages } from '../../../../../../shared/flash_messages'; +import { HttpLogic } from '../../../../../../shared/http'; +import { AppLogic } from '../../../../../app_logic'; +import { CustomSource } from '../../../../../types'; + +export interface AddCustomSourceApiActions { + addSource(name: string, baseServiceType?: string): { name: string; baseServiceType: string }; + addSourceError(code: number, error: string): HttpError; + addSourceSuccess(source: CustomSource): { source: CustomSource }; +} + +export interface AddCustomSourceApiValues { + sourceApi: ApiStatus; +} + +export const AddCustomSourceApiLogic = kea< + MakeLogicType +>({ + path: ['enterprise_search', 'workplace_search', 'add_custom_source_api_logic'], + actions: { + addSource: (name, baseServiceType) => ({ name, baseServiceType }), + addSourceError: (code, error) => ({ code, error }), + addSourceSuccess: (customSource) => ({ source: customSource }), + }, + reducers: () => ({ + sourceApi: [ + { + status: 'IDLE', + }, + { + addSource: () => ({ + status: 'PENDING', + }), + addSourceError: (_, error) => ({ + status: 'ERROR', + error, + }), + addSourceSuccess: (_, { source }) => ({ + status: 'SUCCESS', + data: source, + }), + }, + ], + }), + listeners: ({ actions }) => ({ + addSource: async ({ name, baseServiceType }) => { + clearFlashMessages(); + const { isOrganization } = AppLogic.values; + const route = isOrganization + ? '/internal/workplace_search/org/create_source' + : '/internal/workplace_search/account/create_source'; + + const params = { + service_type: 'custom', + name, + base_service_type: baseServiceType, + }; + + try { + const response = await HttpLogic.values.http.post(route, { + body: JSON.stringify(params), + }); + actions.addSourceSuccess(response); + } catch (e) { + flashAPIErrors(e); + actions.addSourceError(e?.body?.statusCode, e?.body?.message); + } + }, + }), +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts index 2ca3462da0f57..59825c0bd386c 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts @@ -5,21 +5,11 @@ * 2.0. */ -import { - LogicMounter, - mockFlashMessageHelpers, - mockHttpValues, -} from '../../../../../../__mocks__/kea_logic'; -import { sourceConfigData } from '../../../../../__mocks__/content_sources.mock'; - -import { nextTick } from '@kbn/test-jest-helpers'; - -import { itShowsServerErrorAsFlashMessage } from '../../../../../../test_helpers'; +import { LogicMounter } from '../../../../../../__mocks__/kea_logic'; jest.mock('../../../../../app_logic', () => ({ AppLogic: { values: { isOrganization: true } }, })); -import { AppLogic } from '../../../../../app_logic'; import { CustomSource } from '../../../../../types'; @@ -30,14 +20,15 @@ const DEFAULT_VALUES = { buttonLoading: false, customSourceNameValue: '', newCustomSource: {} as CustomSource, + sourceApi: { + status: 'IDLE', + }, }; const MOCK_NAME = 'name'; describe('AddCustomSourceLogic', () => { const { mount } = new LogicMounter(AddCustomSourceLogic); - const { http } = mockHttpValues; - const { clearFlashMessages } = mockFlashMessageHelpers; beforeEach(() => { jest.clearAllMocks(); @@ -49,17 +40,27 @@ describe('AddCustomSourceLogic', () => { }); describe('actions', () => { - describe('setButtonNotLoading', () => { - it('turns off the button loading flag', () => { - AddCustomSourceLogic.actions.setButtonNotLoading(); + describe('addSourceSuccess', () => { + it('sets a new source', () => { + const customSource: CustomSource = { + accessToken: 'a', + name: 'b', + id: '1', + }; + AddCustomSourceLogic.actions.addSourceSuccess(customSource); expect(AddCustomSourceLogic.values).toEqual({ ...DEFAULT_VALUES, - buttonLoading: false, + customSourceNameValue: '', + newCustomSource: customSource, + sourceApi: { + status: 'SUCCESS', + data: customSource, + }, + currentStep: AddCustomSourceSteps.SaveCustomStep, }); }); }); - describe('setCustomSourceNameValue', () => { it('saves the name', () => { AddCustomSourceLogic.actions.setCustomSourceNameValue('name'); @@ -100,27 +101,11 @@ describe('AddCustomSourceLogic', () => { describe('organization context', () => { describe('createContentSource', () => { - it('calls API and sets values', async () => { - const setButtonNotLoadingSpy = jest.spyOn( - AddCustomSourceLogic.actions, - 'setButtonNotLoading' - ); - const setNewCustomSourceSpy = jest.spyOn( - AddCustomSourceLogic.actions, - 'setNewCustomSource' - ); - http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); + it('calls addSource on AddCustomSourceApi logic', async () => { + const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'addSource'); AddCustomSourceLogic.actions.createContentSource(); - - expect(clearFlashMessages).toHaveBeenCalled(); - expect(AddCustomSourceLogic.values.buttonLoading).toEqual(true); - expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { - body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), - }); - await nextTick(); - expect(setNewCustomSourceSpy).toHaveBeenCalledWith({ sourceConfigData }); - expect(setButtonNotLoadingSpy).toHaveBeenCalled(); + expect(addSourceSpy).toHaveBeenCalledWith(MOCK_NAME, undefined); }); it('submits a base service type for pre-configured sources', () => { @@ -133,66 +118,11 @@ describe('AddCustomSourceLogic', () => { } ); - AddCustomSourceLogic.actions.createContentSource(); - - expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { - body: JSON.stringify({ - service_type: 'custom', - name: MOCK_NAME, - base_service_type: 'share_point_server', - }), - }); - }); - - itShowsServerErrorAsFlashMessage(http.post, () => { - AddCustomSourceLogic.actions.createContentSource(); - }); - }); - }); - - describe('account context routes', () => { - beforeEach(() => { - AppLogic.values.isOrganization = false; - }); - - describe('createContentSource', () => { - it('sends relevant fields to the API', () => { - AddCustomSourceLogic.actions.createContentSource(); - - expect(http.post).toHaveBeenCalledWith( - '/internal/workplace_search/account/create_source', - { - body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), - } - ); - }); - - it('submits a base service type for pre-configured sources', () => { - mount( - { - customSourceNameValue: MOCK_NAME, - }, - { - baseServiceType: 'share_point_server', - } - ); + const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'addSource'); AddCustomSourceLogic.actions.createContentSource(); - expect(http.post).toHaveBeenCalledWith( - '/internal/workplace_search/account/create_source', - { - body: JSON.stringify({ - service_type: 'custom', - name: MOCK_NAME, - base_service_type: 'share_point_server', - }), - } - ); - }); - - itShowsServerErrorAsFlashMessage(http.post, () => { - AddCustomSourceLogic.actions.createContentSource(); + expect(addSourceSpy).toHaveBeenCalledWith(MOCK_NAME, 'share_point_server'); }); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts index 5b02fffa5892d..76041744b3c37 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts @@ -7,11 +7,14 @@ import { kea, MakeLogicType } from 'kea'; -import { flashAPIErrors, clearFlashMessages } from '../../../../../../shared/flash_messages'; -import { HttpLogic } from '../../../../../../shared/http'; -import { AppLogic } from '../../../../../app_logic'; import { CustomSource } from '../../../../../types'; +import { + AddCustomSourceApiActions, + AddCustomSourceApiLogic, + AddCustomSourceApiValues, +} from './add_custom_source_api_logic'; + export interface AddCustomSourceProps { baseServiceType?: string; initialValue?: string; @@ -23,8 +26,9 @@ export enum AddCustomSourceSteps { } export interface AddCustomSourceActions { + addSource: AddCustomSourceApiActions['addSource']; + addSourceSuccess: AddCustomSourceApiActions['addSourceSuccess']; createContentSource(): void; - setButtonNotLoading(): void; setCustomSourceNameValue(customSourceNameValue: string): string; setNewCustomSource(data: CustomSource): CustomSource; } @@ -34,6 +38,7 @@ interface AddCustomSourceValues { currentStep: AddCustomSourceSteps; customSourceNameValue: string; newCustomSource: CustomSource; + sourceApi: AddCustomSourceApiValues['sourceApi']; } /** @@ -44,10 +49,13 @@ interface AddCustomSourceValues { export const AddCustomSourceLogic = kea< MakeLogicType >({ + connect: { + actions: [AddCustomSourceApiLogic, ['addSource', 'addSourceSuccess', 'addSourceError']], + values: [AddCustomSourceApiLogic, ['sourceApi']], + }, path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], actions: { createContentSource: true, - setButtonNotLoading: true, setCustomSourceNameValue: (customSourceNameValue) => customSourceNameValue, setNewCustomSource: (data) => data, }, @@ -55,8 +63,9 @@ export const AddCustomSourceLogic = kea< buttonLoading: [ false, { - setButtonNotLoading: () => false, createContentSource: () => true, + addSourceSuccess: () => false, + addSourceError: () => false, }, ], currentStep: [ @@ -79,31 +88,19 @@ export const AddCustomSourceLogic = kea< ], }), listeners: ({ actions, values, props }) => ({ - createContentSource: async () => { - clearFlashMessages(); - const { isOrganization } = AppLogic.values; - const route = isOrganization - ? '/internal/workplace_search/org/create_source' - : '/internal/workplace_search/account/create_source'; - + createContentSource: () => { const { customSourceNameValue } = values; - - const params = { - service_type: 'custom', - name: customSourceNameValue, - base_service_type: props.baseServiceType, - }; - - try { - const response = await HttpLogic.values.http.post(route, { - body: JSON.stringify(params), - }); - actions.setNewCustomSource(response); - } catch (e) { - flashAPIErrors(e); - } finally { - actions.setButtonNotLoading(); - } + const { baseServiceType } = props; + actions.addSource(customSourceNameValue, baseServiceType); + }, + addSourceSuccess: ({ source }) => { + actions.setNewCustomSource(source); }, }), + selectors: { + buttonLoading: [ + (selectors) => [selectors.sourceApi], + (apiStatus) => apiStatus?.status === 'PENDING', + ], + }, }); diff --git a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts index 6365e89fb9184..3c3a1c99796cc 100644 --- a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts @@ -55,7 +55,9 @@ describe('fetchIndices lib function', () => { mockClient.asCurrentUser.indices.get.mockImplementation(() => regularIndexResponse); mockClient.asCurrentUser.indices.stats.mockImplementation(() => regularIndexStatsResponse); - await expect(fetchIndices(mockClient as unknown as IScopedClusterClient)).resolves.toEqual([ + await expect( + fetchIndices(mockClient as unknown as IScopedClusterClient, 'search-*', /search-.*/) + ).resolves.toEqual([ { health: 'green', status: 'open', @@ -104,7 +106,9 @@ describe('fetchIndices lib function', () => { mockClient.asCurrentUser.indices.get.mockImplementationOnce(() => aliasedIndexResponse); mockClient.asCurrentUser.indices.stats.mockImplementationOnce(() => aliasedStatsResponse); - await expect(fetchIndices(mockClient as unknown as IScopedClusterClient)).resolves.toEqual([ + await expect( + fetchIndices(mockClient as unknown as IScopedClusterClient, 'search-*', /search-.*/) + ).resolves.toEqual([ { health: 'green', status: 'open', @@ -149,7 +153,9 @@ describe('fetchIndices lib function', () => { mockClient.asCurrentUser.indices.stats.mockImplementationOnce(() => missingStatsResponse); // simulates when an index has been deleted after get indices call // deleted index won't be present in the indices stats call response - await expect(fetchIndices(mockClient as unknown as IScopedClusterClient)).resolves.toEqual([ + await expect( + fetchIndices(mockClient as unknown as IScopedClusterClient, 'search-*', /search-.*/) + ).resolves.toEqual([ { name: 'search-regular-index', total: { @@ -170,7 +176,9 @@ describe('fetchIndices lib function', () => { it('should return empty array when no index found', async () => { mockClient.asCurrentUser.indices.get.mockImplementationOnce(() => ({})); - await expect(fetchIndices(mockClient as unknown as IScopedClusterClient)).resolves.toEqual([]); + await expect( + fetchIndices(mockClient as unknown as IScopedClusterClient, 'search-*', /search-.*/) + ).resolves.toEqual([]); expect(mockClient.asCurrentUser.indices.stats).not.toHaveBeenCalled(); }); }); diff --git a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts index ac811ba9ed4f7..31feb8ecd9d5c 100644 --- a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts +++ b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts @@ -10,13 +10,14 @@ import { IScopedClusterClient } from '@kbn/core/server'; import { ElasticsearchIndex } from '../../common/types'; -export const fetchIndices = async (client: IScopedClusterClient): Promise => { - const indexNamesString = 'search-*'; - const indexNamesRegEx = /^search-*/; - +export const fetchIndices = async ( + client: IScopedClusterClient, + indexPattern: string, + indexRegExp: RegExp +): Promise => { // This call retrieves alias and settings information about indices const indices = await client.asCurrentUser.indices.get({ - index: indexNamesString, + index: indexPattern, expand_wildcards: ['open'], // only get specified index properties from ES to keep the response under 536MB // node.js string length limit: https://github.com/nodejs/node/issues/33960 @@ -30,7 +31,7 @@ export const fetchIndices = async (client: IScopedClusterClient): Promise name.match(indexNamesRegEx)); + .filter(({ name }) => name.match(indexRegExp)); }; diff --git a/x-pack/plugins/enterprise_search/server/plugin.ts b/x-pack/plugins/enterprise_search/server/plugin.ts index c3dbfd99359de..110adec8bc211 100644 --- a/x-pack/plugins/enterprise_search/server/plugin.ts +++ b/x-pack/plugins/enterprise_search/server/plugin.ts @@ -46,7 +46,7 @@ import { import { registerAppSearchRoutes } from './routes/app_search'; import { registerConfigDataRoute } from './routes/enterprise_search/config_data'; -import { registerListRoute } from './routes/enterprise_search/indices'; +import { registerIndexRoutes } from './routes/enterprise_search/indices'; import { registerTelemetryRoute } from './routes/enterprise_search/telemetry'; import { registerWorkplaceSearchRoutes } from './routes/workplace_search'; @@ -160,7 +160,7 @@ export class EnterpriseSearchPlugin implements Plugin { registerConfigDataRoute(dependencies); registerAppSearchRoutes(dependencies); registerWorkplaceSearchRoutes(dependencies); - registerListRoute(dependencies); + registerIndexRoutes(dependencies); /** * Bootstrap the routes, saved objects, and collector for telemetry diff --git a/x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts b/x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts index 65868e4d17935..6ae65ee4c8933 100644 --- a/x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts +++ b/x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts @@ -5,16 +5,18 @@ * 2.0. */ +import { schema } from '@kbn/config-schema'; + import { fetchIndices } from '../../lib/fetch_indices'; import { RouteDependencies } from '../../plugin'; -export function registerListRoute({ router }: RouteDependencies) { +export function registerIndexRoutes({ router }: RouteDependencies) { router.get( - { path: '/internal/enterprise_search/indices', validate: false }, + { path: '/internal/enterprise_search/search_indices', validate: false }, async (context, _, response) => { const { client } = (await context.core).elasticsearch; try { - const indices = await fetchIndices(client); + const indices = await fetchIndices(client, 'search-*', /^search-.*/); return response.ok({ body: indices, headers: { 'content-type': 'application/json' }, @@ -27,4 +29,45 @@ export function registerListRoute({ router }: RouteDependencies) { } } ); + router.get( + { + path: '/internal/enterprise_search/indices', + validate: { + query: schema.object({ + page: schema.number({ defaultValue: 1, min: 0 }), + size: schema.number({ defaultValue: 10, min: 0 }), + }), + }, + }, + async (context, request, response) => { + const { page, size } = request.query; + const { client } = (await context.core).elasticsearch; + try { + const indices = await fetchIndices(client, '*', /.*/); + const totalResults = indices.length; + const totalPages = Math.ceil(totalResults / size); + const startIndex = (page - 1) * size; + const endIndex = page * size; + return response.ok({ + body: { + meta: { + page: { + current: page, + size, + totalPages, + totalResults, + }, + }, + indices: indices.slice(startIndex, endIndex), + }, + headers: { 'content-type': 'application/json' }, + }); + } catch (error) { + return response.customError({ + statusCode: 502, + body: 'Error fetching index data from Elasticsearch', + }); + } + } + ); } diff --git a/x-pack/plugins/fleet/common/constants/agent_policy.ts b/x-pack/plugins/fleet/common/constants/agent_policy.ts index 316c66d2c75d6..3a24bbd4a18c0 100644 --- a/x-pack/plugins/fleet/common/constants/agent_policy.ts +++ b/x-pack/plugins/fleet/common/constants/agent_policy.ts @@ -26,3 +26,5 @@ export const AGENT_POLICY_DEFAULT_MONITORING_DATASETS = [ 'elastic_agent.heartbeat', 'elastic_agent.cloudbeat', ]; + +export const LICENSE_FOR_SCHEDULE_UPGRADE = 'platinum'; diff --git a/x-pack/plugins/fleet/common/constants/routes.ts b/x-pack/plugins/fleet/common/constants/routes.ts index 7b185960dcb7b..33bf1b6f6b5b7 100644 --- a/x-pack/plugins/fleet/common/constants/routes.ts +++ b/x-pack/plugins/fleet/common/constants/routes.ts @@ -54,6 +54,7 @@ export const PACKAGE_POLICY_API_ROUTES = { DELETE_PATTERN: `${PACKAGE_POLICY_API_ROOT}/delete`, UPGRADE_PATTERN: `${PACKAGE_POLICY_API_ROOT}/upgrade`, DRYRUN_PATTERN: `${PACKAGE_POLICY_API_ROOT}/upgrade/dryrun`, + ORPHANED_INTEGRATION_POLICIES: `${INTERNAL_ROOT}/orphaned_integration_policies`, }; // Agent policy API routes @@ -92,6 +93,7 @@ export const SETTINGS_API_ROUTES = { // App API routes export const APP_API_ROUTES = { + HEALTH_CHECK_PATTERN: `${API_ROOT}/health_check`, CHECK_PERMISSIONS_PATTERN: `${API_ROOT}/check-permissions`, GENERATE_SERVICE_TOKEN_PATTERN: `${API_ROOT}/service_tokens`, // deprecated since 8.0 diff --git a/x-pack/plugins/fleet/common/services/routes.ts b/x-pack/plugins/fleet/common/services/routes.ts index a8a6c34f06f3c..8c66a11cd3569 100644 --- a/x-pack/plugins/fleet/common/services/routes.ts +++ b/x-pack/plugins/fleet/common/services/routes.ts @@ -19,6 +19,7 @@ import { SETTINGS_API_ROUTES, APP_API_ROUTES, K8S_API_ROUTES, + PRECONFIGURATION_API_ROUTES, } from '../constants'; export const epmRouteService = { @@ -105,6 +106,10 @@ export const packagePolicyRouteService = { getDryRunPath: () => { return PACKAGE_POLICY_API_ROUTES.DRYRUN_PATTERN; }, + + getOrphanedIntegrationPoliciesPath: () => { + return PACKAGE_POLICY_API_ROUTES.ORPHANED_INTEGRATION_POLICIES; + }, }; export const agentPolicyRouteService = { @@ -150,6 +155,14 @@ export const agentPolicyRouteService = { getK8sFullDownloadPath: () => { return K8S_API_ROUTES.K8S_DOWNLOAD_PATTERN; }, + + getResetOnePreconfiguredAgentPolicyPath: (agentPolicyId: string) => { + return PRECONFIGURATION_API_ROUTES.RESET_ONE_PATTERN.replace(`{agentPolicyId}`, agentPolicyId); + }, + + getResetAllPreconfiguredAgentPolicyPath: () => { + return PRECONFIGURATION_API_ROUTES.RESET_PATTERN; + }, }; export const dataStreamRouteService = { diff --git a/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts b/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts index 35202a0eb42aa..b2cb1a4561394 100644 --- a/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts +++ b/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts @@ -49,6 +49,7 @@ export type UpdatePackagePolicyResponse = CreatePackagePolicyResponse; export interface DeletePackagePoliciesRequest { body: { packagePolicyIds: string[]; + force?: boolean; }; } diff --git a/x-pack/plugins/fleet/dev_docs/fleet_debugger.md b/x-pack/plugins/fleet/dev_docs/fleet_debugger.md new file mode 100644 index 0000000000000..cafaeaae71f37 --- /dev/null +++ b/x-pack/plugins/fleet/dev_docs/fleet_debugger.md @@ -0,0 +1,27 @@ +# Fleet Debugger + +Fleet includes a "debug" interface that provides some insight and data management capabilities around Fleet's underlying data. This interface can be used to diagnose issues, assist support engineers, and restore functionality to broken Fleet installations. + +![Fleet Debugger UI Screenshot](https://user-images.githubusercontent.com/6766512/167193984-fcb100c4-729d-4a0b-ae64-2b280272da96.png) + +## Accessing the Fleet debugger + +The debugger is served at `/app/fleet/_debug`. This page shares the same permissions requirement as other `/fleet` pages, so you'll need a user with the `fleet.all` permission. + +## Using the Fleet debugger + +The Fleet debugger provides debugger modules for the following Fleet data: + +- Agent Policies +- Installed Integrations +- Saved Objects +- System Indices +- Preconfiguration +- "Orphaned" Integration Policies + +Each module contains an explanation of its functionality and behavior, but generally the goal of each module is to + +1. Provide visibility into the underlying data for the given object +1. Provide cleanup/reset functionality in order to recover from malformed data that may be preventing normal usage of Fleet + +The debugger should be used when possible to assist with SDH's when we request things like a copy/paste of a given policy object or for some cleanup operation to be run via `cURL`. As common SDH tasks are identified, the debugger should be expanded to suit the Fleet UI team's and the support team's needs. diff --git a/x-pack/plugins/fleet/public/applications/fleet/app.tsx b/x-pack/plugins/fleet/public/applications/fleet/app.tsx index eb8b01d831cd5..ca8083fb51325 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/app.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/app.tsx @@ -58,6 +58,7 @@ import { MissingESRequirementsPage } from './sections/agents/agent_requirements_ import { CreatePackagePolicyPage } from './sections/agent_policy/create_package_policy_page'; import { EnrollmentTokenListPage } from './sections/agents/enrollment_token_list_page'; import { SettingsApp } from './sections/settings'; +import { DebugPage } from './sections/debug'; const FEEDBACK_URL = 'https://ela.st/fleet-feedback'; @@ -326,6 +327,10 @@ export const AppRoutes = memo( + + + + {/* TODO: Move this route to the Integrations app */} diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx index cc7a9bec975ef..947cb050f3c16 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx @@ -29,7 +29,7 @@ import semverCoerce from 'semver/functions/coerce'; import { createStateContainerReactHelpers } from '@kbn/kibana-utils-plugin/public'; import { RedirectAppLinks } from '@kbn/kibana-react-plugin/public'; -import type { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { LogStream } from '@kbn/infra-plugin/public'; import type { Agent, AgentPolicy } from '../../../../../types'; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx index 8d35b3bcd19f1..6148b39b088af 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx @@ -24,6 +24,8 @@ import { AgentUnenrollAgentModal, AgentUpgradeAgentModal, } from '../../components'; +import { useLicense } from '../../../../hooks'; +import { LICENSE_FOR_SCHEDULE_UPGRADE } from '../../../../../../../common'; import type { SelectionMode } from './types'; @@ -47,6 +49,9 @@ export const AgentBulkActions: React.FunctionComponent = ({ selectedAgents, refreshAgents, }) => { + const licenseService = useLicense(); + const isLicenceAllowingScheduleUpgrade = licenseService.hasAtLeast(LICENSE_FOR_SCHEDULE_UPGRADE); + // Bulk actions menu states const [isMenuOpen, setIsMenuOpen] = useState(false); const closeMenu = () => setIsMenuOpen(false); @@ -133,7 +138,7 @@ export const AgentBulkActions: React.FunctionComponent = ({ /> ), icon: , - disabled: !atLeastOneActiveAgentSelected, + disabled: !atLeastOneActiveAgentSelected || !isLicenceAllowingScheduleUpgrade, onClick: () => { closeMenu(); setUpgradeModalState({ isOpen: true, isScheduled: true }); diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx new file mode 100644 index 0000000000000..71ee096f1e4fa --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx @@ -0,0 +1,172 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React, { useState } from 'react'; +import { + EuiButton, + EuiCallOut, + EuiCode, + EuiComboBox, + EuiFlexGroup, + EuiFlexItem, + EuiLink, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useQuery } from 'react-query'; + +import { FormattedMessage } from '@kbn/i18n-react'; +import { i18n } from '@kbn/i18n'; + +import { sendGetAgentPolicies, useLink } from '../../../hooks'; +import { SO_SEARCH_LIMIT } from '../../../constants'; + +import { policyHasFleetServer } from '../../../services'; +import type { AgentPolicy } from '../../../types'; +import { AgentPolicyDeleteProvider } from '../../agent_policy/components'; + +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchAgentPolicies = async () => { + const response = await sendGetAgentPolicies({ + full: true, + perPage: SO_SEARCH_LIMIT, + sortOrder: 'asc', + }); + + if (response.error) { + throw new Error(response.error.message); + } + + return response; +}; + +export const AgentPolicyDebugger: React.FunctionComponent = () => { + const { getHref } = useLink(); + const [selectedPolicyId, setSelectedPolicyId] = useState(); + + // TODO: Depending on the number of agent policies, this might need to be switched to + // `useInfinite` query with an infinite scrolling approach in the dropdown options. + const { data, status } = useQuery('debug-agent-policies', fetchAgentPolicies); + + const agentPolicies = data?.data?.items ?? []; + const comboBoxOptions = agentPolicies.map((policy) => ({ + label: `${policy.name} - ${policy.id}`, + value: policy.id, + })); + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find((option) => option.value === selectedPolicyId)!] + : []; + + const selectedAgentPolicy = agentPolicies.find((policy) => policy.id === selectedPolicyId); + + const onDelete = () => { + setSelectedPolicyId(undefined); + queryClient.invalidateQueries('debug-agent-policies'); + }; + + if (status === 'error') { + return ( + + + + ); + } + + return ( + <> + +

+ id }} + /> +

+ + + + + + + { + // Handle "clear" action + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + {selectedPolicyId && ( + + {(deleteAgentPolicyPrompt) => { + return ( + +
+ deleteAgentPolicyPrompt(selectedPolicyId, onDelete)} + > + + +
+ + ); + }} + + )} + + + {selectedPolicyId && ( + <> + + + + + + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx new file mode 100644 index 0000000000000..3addcaa862c3f --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx @@ -0,0 +1,38 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { CodeEditor } from '@kbn/kibana-react-plugin/public'; + +/** + * A read-only code block with various default settings suitable for displaying API responses, etc + */ +export const CodeBlock: React.FunctionComponent<{ value: string }> = ({ value }) => { + return ( + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx new file mode 100644 index 0000000000000..7c0c81858414a --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx @@ -0,0 +1,120 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiCallOut, + EuiComboBox, + EuiFlexGroup, + EuiFlexItem, + EuiFormRow, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { sendRequest } from '../../../hooks'; + +import { CodeBlock } from './code_block'; + +const fetchIndex = async (index?: string) => { + if (!index) return; + const path = `/${index}/_search`; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + }); + + return response; +}; + +export const FleetIndexDebugger = () => { + const indices = [ + { label: '.fleet-agents', value: '.fleet-agents' }, + { label: '.fleet-actions', value: '.fleet-actions' }, + ]; + const [index, setIndex] = useState(); + + const { data: indexResult, status } = useQuery( + ['debug-indices', index], + () => fetchIndex(index), + { + retry: false, + } + ); + + const selectedOptions = index ? [indices.find((option) => option.value === index)!] : []; + + return ( + <> + +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setIndex(undefined); + } else { + setIndex(newSelectedOptions[0].value as string); + } + }} + /> + + + + {indexResult?.error && ( + <> + + + {(indexResult?.error as any)?.error?.reason ?? ( + + )} + + + )} + + {indexResult && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx new file mode 100644 index 0000000000000..6a89a696874a7 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './agent_policy_debugger'; +export * from './integration_debugger'; +export * from './saved_object_debugger'; +export * from './preconfiguration_debugger'; +export * from './fleet_index_debugger'; +export * from './orphaned_integration_policy_debugger'; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx new file mode 100644 index 0000000000000..92f82285357f0 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx @@ -0,0 +1,314 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiButton, + EuiButtonEmpty, + EuiCallOut, + EuiComboBox, + EuiConfirmModal, + EuiFlexGroup, + EuiFlexItem, + EuiHighlight, + EuiIcon, + EuiLink, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { getEuiIconType } from '../../../../../services/icons'; + +import { + sendGetPackages, + sendInstallPackage, + sendRemovePackage, + useLink, + useStartServices, +} from '../../../hooks'; +import type { PackageListItem } from '../../../types'; +import { queryClient } from '..'; +import { pkgKeyFromPackageInfo } from '../../../services'; + +const fetchInstalledIntegrations = async () => { + const response = await sendGetPackages({ experimental: true }); + + if (response.error) { + throw new Error(response.error.message); + } + + const installedIntegrations = response.data?.items.filter(({ status }) => status === 'installed'); + + return installedIntegrations; +}; + +export const IntegrationDebugger: React.FunctionComponent = () => { + const { http, notifications } = useStartServices(); + const { getHref } = useLink(); + + const [selectedIntegrationId, setSelectedIntegrationId] = useState(); + const [isReinstallModalVisible, setIsReinstallModalVisible] = useState(false); + const [isUninstallModalVisible, setIsUninstallModalVisible] = useState(false); + + const integrations = useQuery('debug-integrations', fetchInstalledIntegrations); + + const uninstallMutation = useMutation(async (integration: PackageListItem) => { + const response = await sendRemovePackage(integration.name, integration.version, true); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.uninstall.error', { + defaultMessage: 'Error uninstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: response.error.message, + }); + + setIsUninstallModalVisible(false); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.integrationDebugger.uninstall.success', { + defaultMessage: 'Successfully uninstalled {integrationTitle}', + values: { integrationTitle: integration.title }, + }) + ); + + setSelectedIntegrationId(undefined); + setIsUninstallModalVisible(false); + + queryClient.invalidateQueries('debug-integrations'); + + return response.data; + }); + + const reinstallMutation = useMutation(async (integration: PackageListItem) => { + const uninstallResponse = await sendRemovePackage(integration.name, integration.version, true); + + if (uninstallResponse.error) { + notifications.toasts.addError(uninstallResponse.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.error', { + defaultMessage: 'Error reinstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: uninstallResponse.error.message, + }); + + setIsReinstallModalVisible(false); + throw new Error(uninstallResponse.error.message); + } + + const installResponse = await sendInstallPackage(integration.name, integration.version); + + if (installResponse.error) { + notifications.toasts.addError(installResponse.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.error', { + defaultMessage: 'Error reinstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: installResponse.error.message, + }); + + setIsReinstallModalVisible(false); + throw new Error(installResponse.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.success', { + defaultMessage: 'Successfully reinstalled {integrationTitle}', + values: { integrationTitle: integration.title }, + }) + ); + + setSelectedIntegrationId(undefined); + setIsReinstallModalVisible(false); + + queryClient.invalidateQueries('debug-integrations'); + + return installResponse.data; + }); + + if (integrations.status === 'error') { + return ( + + + + ); + } + + const comboBoxOptions = + integrations.data?.map((integration) => ({ + label: integration.name, + value: integration.id, + icon: getEuiIconType(integration, http.basePath), + })) ?? []; + + const selectedOptions = selectedIntegrationId + ? [comboBoxOptions.find((option) => option.value === selectedIntegrationId)!] + : []; + + const selectedIntegration = integrations.data?.find( + (integration) => integration.id === selectedIntegrationId + ); + + return ( + <> + +

+ +

+ +

+ +

+ + + + + + + 0 ? ( + + + + ) : undefined + } + renderOption={(option, searchValue, contentClassName) => ( + + +   + {option.label} + + )} + onChange={(newSelectedOptions) => { + // Handle "clear" action + if (!newSelectedOptions.length) { + setSelectedIntegrationId(undefined); + } else { + setSelectedIntegrationId(newSelectedOptions[0].value); + } + }} + /> + + + {selectedIntegration && ( + + + setIsReinstallModalVisible(true)}> + Reinstall + + + + + setIsUninstallModalVisible(true)}> + Uninstall + + + + {isReinstallModalVisible && ( + setIsReinstallModalVisible(false)} + onConfirm={() => reinstallMutation.mutate(selectedIntegration)} + isLoading={reinstallMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.cancelReinstall', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.confirmReinstall', + { defaultMessage: 'Reinstall' } + )} + > + + + )} + + {isUninstallModalVisible && ( + setIsUninstallModalVisible(false)} + onConfirm={() => uninstallMutation.mutate(selectedIntegration)} + isLoading={uninstallMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.cancelUninstall', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.confirmUninstall', + { defaultMessage: 'Uninstall' } + )} + > + + + )} + + )} + + + {selectedIntegration && ( + <> + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx new file mode 100644 index 0000000000000..abc84ad425900 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx @@ -0,0 +1,262 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiSpacer, + EuiText, + EuiFlexGroup, + EuiComboBox, + EuiFlexItem, + EuiButton, + EuiConfirmModal, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { + sendDeletePackagePolicy, + sendGetOrphanedIntegrationPolicies, + useStartServices, +} from '../../../hooks'; +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchOrphanedPolicies = async () => { + const response = await sendGetOrphanedIntegrationPolicies(); + + if (response.error) { + throw new Error(response.error.message); + } + + return response.data?.items ?? []; +}; + +export const OrphanedIntegrationPolicyDebugger: React.FunctionComponent = () => { + const { notifications } = useStartServices(); + + const [selectedPolicyId, setSelectedPolicyId] = useState(); + const [isDeleteModalVisible, setIsDeleteModalVisible] = useState(false); + const [isDeleteAllModalVisible, setIsDeleteAllModalVisible] = useState(false); + + const { data: orphanedPolicies } = useQuery('debug-orphaned-policies', fetchOrphanedPolicies); + + const comboBoxOptions = + orphanedPolicies?.map((policy: { id: string; name: string }) => ({ + label: policy.name, + value: policy.id, + })) ?? []; + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find(({ value }: { value: string }) => value === selectedPolicyId)!] + : []; + + const selectedPolicy = orphanedPolicies?.find( + (policy: { id: string }) => policy.id === selectedPolicyId + ); + + const deleteOnePolicyMutation = useMutation(async (policyId: string) => { + const response = await sendDeletePackagePolicy({ + packagePolicyIds: [policyId], + force: true, + }); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteError', { + defaultMessage: 'Error deleting policy', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteSuccess', { + defaultMessage: 'Successfully deleted orphaned policy', + }) + ); + queryClient.invalidateQueries('debug-orphaned-policies'); + setSelectedPolicyId(undefined); + setIsDeleteModalVisible(false); + + return response.data; + }); + + const deleteAllPoliciesMutation = useMutation(async () => { + const response = await sendDeletePackagePolicy({ + packagePolicyIds: orphanedPolicies?.map((policy: { id: string }) => policy.id), + force: true, + }); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteAllError', + { defaultMessage: 'Error deleting orphaned policies' } + ), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteAllSuccess', { + defaultMessage: 'Successfully deleted all orphaned policies', + }) + ); + queryClient.invalidateQueries('debug-orphaned-policies'); + setSelectedPolicyId(undefined); + setIsDeleteAllModalVisible(false); + + return response.data; + }); + + return ( + <> + +

+ +

+ +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + +
+ setIsDeleteModalVisible(true)} + > + + +
+ + + +
+ setIsDeleteAllModalVisible(true)} + > + + +
+ + + + {isDeleteModalVisible && selectedPolicy && selectedPolicyId && ( + setIsDeleteModalVisible(false)} + onConfirm={() => deleteOnePolicyMutation.mutate(selectedPolicyId)} + isLoading={deleteOnePolicyMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.cancelDelete', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.confirmDelete', + { defaultMessage: 'Delete' } + )} + > + + + )} + + {isDeleteAllModalVisible && ( + setIsDeleteAllModalVisible(false)} + onConfirm={() => deleteAllPoliciesMutation.mutate()} + isLoading={deleteAllPoliciesMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.cancelDeleteAll', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.confirmDeleteAll', + { defaultMessage: 'Delete all' } + )} + > + + + )} + + {selectedPolicyId && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx new file mode 100644 index 0000000000000..35e9bcba75492 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx @@ -0,0 +1,272 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiSpacer, + EuiText, + EuiCode, + EuiFlexGroup, + EuiComboBox, + EuiFlexItem, + EuiButton, + EuiLink, + EuiConfirmModal, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { + sendGetAgentPolicies, + sendResetAllPreconfiguredAgentPolicies, + sendResetOnePreconfiguredAgentPolicy, + useLink, + useStartServices, +} from '../../../hooks'; +import { AGENT_POLICY_SAVED_OBJECT_TYPE, SO_SEARCH_LIMIT } from '../../../constants'; +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchPreconfiguredPolicies = async () => { + const kuery = `${AGENT_POLICY_SAVED_OBJECT_TYPE}.is_preconfigured:true`; + + const response = await sendGetAgentPolicies({ kuery, perPage: SO_SEARCH_LIMIT, full: true }); + + if (response.error) { + throw new Error(response.error.message); + } + + return response.data?.items ?? []; +}; + +export const PreconfigurationDebugger: React.FunctionComponent = () => { + const { getHref } = useLink(); + const { notifications } = useStartServices(); + + const [selectedPolicyId, setSelectedPolicyId] = useState(); + const [isResetModalVisible, setIsResetModalVisible] = useState(false); + const [isResetAllModalVisible, setIsResetAllModalVisible] = useState(false); + + const preconfiguredPolicies = useQuery( + 'debug-preconfigured-policies', + fetchPreconfiguredPolicies + ); + + const comboBoxOptions = + preconfiguredPolicies.data?.map((policy) => ({ + label: policy.name, + value: policy.id, + })) ?? []; + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find(({ value }) => value === selectedPolicyId)!] + : []; + + const selectedPolicy = preconfiguredPolicies.data?.find( + (policy) => policy.id === selectedPolicyId + ); + + const resetOnePolicyMutation = useMutation(async (policyId: string) => { + const response = await sendResetOnePreconfiguredAgentPolicy(policyId); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetError', { + defaultMessage: 'Error resetting policy', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetSuccess', { + defaultMessage: 'Successfully reset policy', + }) + ); + queryClient.invalidateQueries('debug-preconfigured-policies'); + setSelectedPolicyId(undefined); + setIsResetModalVisible(false); + + return response.data; + }); + + const resetAllPoliciesMutation = useMutation(async () => { + const response = await sendResetAllPreconfiguredAgentPolicies(); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetAllError', { + defaultMessage: 'Error resetting policies', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetAllSuccess', { + defaultMessage: 'Successfully reset policies', + }) + ); + queryClient.invalidateQueries('debug-preconfigured-policies'); + setSelectedPolicyId(undefined); + setIsResetAllModalVisible(false); + + return response.data; + }); + + return ( + <> + +

+ kibana.yml }} + /> +

+ +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + +
+ setIsResetModalVisible(true)} + > + + +
+ + + +
+ setIsResetAllModalVisible(true)} + > + + +
+ + + + {isResetModalVisible && selectedPolicy && selectedPolicyId && ( + setIsResetModalVisible(false)} + onConfirm={() => resetOnePolicyMutation.mutate(selectedPolicyId)} + isLoading={resetOnePolicyMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetModalCancel', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetModalConfirm', + { defaultMessage: 'Reset' } + )} + > + + + )} + + {isResetAllModalVisible && ( + setIsResetAllModalVisible(false)} + onConfirm={() => resetAllPoliciesMutation.mutate()} + isLoading={resetAllPoliciesMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetAllModalCancel', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetAllModalConfirm', + { defaultMessage: 'Reset all' } + )} + > + + + )} + + {selectedPolicyId && ( + <> + + + + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx new file mode 100644 index 0000000000000..c23b383d96f9d --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx @@ -0,0 +1,178 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState, useRef } from 'react'; +import { useQuery } from 'react-query'; +import { + EuiFlexGroup, + EuiFlexItem, + EuiFormRow, + EuiSelect, + EuiSpacer, + EuiText, + EuiCallOut, +} from '@elastic/eui'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { sendRequest } from '../../../hooks'; + +import { CodeBlock } from './code_block'; +import { SavedObjectNamesCombo } from './saved_object_names_combo'; + +const fetchSavedObjects = async (type?: string, name?: string) => { + if (!type || !name) return; + const path = `/.kibana/_search`; + const body = { + query: { + bool: { + must: { + match: { [`${type}.name`]: name }, + }, + filter: { + term: { + type, + }, + }, + }, + }, + }; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + body, + }); + + if (response.error) { + throw new Error(response.error.message); + } + return response.data?.hits; +}; + +export const SavedObjectDebugger: React.FunctionComponent = () => { + const types = [ + { + value: 'ingest-agent-policies', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.agentPolicyLabel', { + defaultMessage: 'Agent policy', + }), + }, + { + value: 'ingest-package-policies', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.packagePolicyLabel', { + defaultMessage: 'Integration policy', + }), + }, + { + value: 'ingest-outputs', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.outputLabel', { + defaultMessage: 'Output', + }), + }, + { + value: 'epm-packages', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.packageLabel', { + defaultMessage: 'Packages', + }), + }, + ]; + + const [type, setType] = useState(types[0].value); + const [name, setName] = useState(); + const [namesStatus, setNamesStatus] = useState(); + + const childRef = useRef<{ refetchNames: Function }>(); + + const onTypeChange = (e: any) => { + setType(e.target.value); + setName(undefined); + childRef.current!.refetchNames(); + }; + + const { data: savedObjectResult, status } = useQuery(['debug-saved-objects', type, name], () => + fetchSavedObjects(type, name) + ); + + return ( + <> + +

+ +

+ + + + + + + + onTypeChange(e)} + aria-label={i18n.translate('xpack.fleet.debug.savedObjectDebugger.selectTypeLabel', { + defaultMessage: 'Select saved object type', + })} + /> + + + + + + + + + + {(status === 'error' || namesStatus === 'error') && ( + <> + + + + + + )} + + {/* Allowing this to render while status === loading prevents the Code Block UI from + flickering when selecting a new object */} + {(savedObjectResult || status === 'loading') && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx new file mode 100644 index 0000000000000..9458bca298b9a --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx @@ -0,0 +1,110 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { forwardRef, useImperativeHandle } from 'react'; +import { useQuery } from 'react-query'; +import { EuiComboBox } from '@elastic/eui'; + +import { i18n } from '@kbn/i18n'; + +import { sendRequest } from '../../../hooks'; + +const fetchSavedObjectNames = async (type: string) => { + const path = `/.kibana/_search`; + const body = { + size: 0, + query: { + bool: { + filter: { + term: { + type, + }, + }, + }, + }, + aggs: { + names: { + terms: { field: `${type}.name`, size: 500 }, + }, + }, + }; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + body, + }); + + if (response.error) { + throw new Error(response.error.message); + } + return response.data?.aggregations.names.buckets; +}; + +interface SavedObjectNamesComboProps { + name: string; + setName: Function; + type: string; + setNamesStatus: Function; +} + +export const SavedObjectNamesCombo = forwardRef( + ({ name, setName, type, setNamesStatus }: SavedObjectNamesComboProps, ref) => { + const { + data: savedObjectNames, + refetch, + status, + } = useQuery(['debug-saved-object-names', type], () => fetchSavedObjectNames(type), { + refetchOnWindowFocus: false, + }); + + setNamesStatus?.(status); + + useImperativeHandle(ref, () => ({ + refetchNames: refetch, + })); + + const comboBoxOptions = (savedObjectNames ?? []).map((obj: { key: string }) => ({ + label: obj.key, + value: obj.key, + })); + + const selectedOption = comboBoxOptions.find( + (option: { value: string }) => option.value === name + )!; + const selectedOptions = selectedOption ? [selectedOption] : []; + + return ( + { + if (!newSelectedOptions.length) { + setName(undefined); + } else { + setName(newSelectedOptions[0].value as string); + } + }} + /> + ); + } +); diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx new file mode 100644 index 0000000000000..b54a97d3b270c --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx @@ -0,0 +1,187 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { + EuiAccordion, + EuiCallOut, + EuiHorizontalRule, + EuiListGroup, + EuiPage, + EuiPageBody, + EuiPageHeader, + EuiSpacer, + EuiText, + EuiTitle, +} from '@elastic/eui'; +import { QueryClient, QueryClientProvider } from 'react-query'; +import { ReactQueryDevtools } from 'react-query/devtools'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { useLink, useStartServices } from '../../hooks'; + +import { + AgentPolicyDebugger, + IntegrationDebugger, + PreconfigurationDebugger, + FleetIndexDebugger, + SavedObjectDebugger, + OrphanedIntegrationPolicyDebugger, +} from './components'; + +// TODO: Evaluate moving this react-query initialization up to the main Fleet app +// setup if we end up pursuing wider adoption of react-query. +export const queryClient = new QueryClient(); + +const panels = [ + { + title: i18n.translate('xpack.fleet.debug.agentPolicyDebugger.title', { + defaultMessage: 'Agent Policy Debugger', + }), + id: 'agentPolicyDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.title', { + defaultMessage: 'Integration Debugger', + }), + id: 'integrationDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.savedObjectDebugger.title', { + defaultMessage: 'Saved Object Debugger', + }), + id: 'savedObjectDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.fleetIndexDebugger.title', { + defaultMessage: 'Fleet Index Debugger', + }), + id: 'fleetIndexDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.title', { + defaultMessage: 'Preconfiguration Debugger', + }), + id: 'preconfigurationDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.title', { + defaultMessage: 'Orphaned Integration Policy Debugger', + }), + id: 'orphanedIntegrationPolicyDebugger', + component: , + }, +]; + +export const DebugPage: React.FunctionComponent = () => { + const { chrome } = useStartServices(); + const { getHref } = useLink(); + + chrome.docTitle.change(['Debug', 'Fleet']); + + return ( + + + + + + + + + + ), + strongLossOfData: ( + + + + ), + }} + /> + + + + + + {panels.map(({ title, id, component }) => ( + <> + +

{title}

+ + } + > + + {component} + + + + + ))} + + +

+ +

+ + + + + + + + + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/settings/components/settings_page/settings_section.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/settings/components/settings_page/settings_section.tsx index 13d3657276335..a5a970dbdb98c 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/settings/components/settings_page/settings_section.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/settings/components/settings_page/settings_section.tsx @@ -54,7 +54,7 @@ export const SettingsSection: React.FunctionComponent = ({ ), diff --git a/x-pack/plugins/fleet/public/constants/page_paths.ts b/x-pack/plugins/fleet/public/constants/page_paths.ts index 26db09d68f41d..e7134f8549e27 100644 --- a/x-pack/plugins/fleet/public/constants/page_paths.ts +++ b/x-pack/plugins/fleet/public/constants/page_paths.ts @@ -17,7 +17,8 @@ export type StaticPage = | 'data_streams' | 'settings' | 'settings_edit_fleet_server_hosts' - | 'settings_create_outputs'; + | 'settings_create_outputs' + | 'debug'; export type DynamicPage = | 'integrations_all' @@ -67,6 +68,7 @@ export const FLEET_ROUTING_PATHS = { settings_edit_fleet_server_hosts: '/settings/edit-fleet-server-hosts', settings_create_outputs: '/settings/create-outputs', settings_edit_outputs: '/settings/outputs/:outputId', + debug: '/_debug', // TODO: Move this to the integrations app add_integration_to_policy: '/integrations/:pkgkey/add-integration/:integration?', @@ -190,4 +192,5 @@ export const pagePathGetters: { FLEET_ROUTING_PATHS.settings_edit_outputs.replace(':outputId', outputId as string), ], settings_create_outputs: () => [FLEET_BASE_PATH, FLEET_ROUTING_PATHS.settings_create_outputs], + debug: () => [FLEET_BASE_PATH, FLEET_ROUTING_PATHS.debug], }; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts b/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts index 777a74b079d7b..248fb60f5bf70 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts @@ -115,3 +115,19 @@ export const sendDeleteAgentPolicy = (body: DeleteAgentPolicyRequest['body']) => body: JSON.stringify(body), }); }; + +export const sendResetOnePreconfiguredAgentPolicy = (agentPolicyId: string) => { + return sendRequest({ + path: agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath(agentPolicyId), + method: 'post', + body: JSON.stringify({}), + }); +}; + +export const sendResetAllPreconfiguredAgentPolicies = () => { + return sendRequest({ + path: agentPolicyRouteService.getResetAllPreconfiguredAgentPolicyPath(), + method: 'post', + body: JSON.stringify({}), + }); +}; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/epm.ts b/x-pack/plugins/fleet/public/hooks/use_request/epm.ts index 7864f08d19a6e..02959d06327cb 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/epm.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/epm.ts @@ -109,10 +109,13 @@ export const sendInstallPackage = (pkgName: string, pkgVersion: string) => { }); }; -export const sendRemovePackage = (pkgName: string, pkgVersion: string) => { +export const sendRemovePackage = (pkgName: string, pkgVersion: string, force: boolean = false) => { return sendRequest({ path: epmRouteService.getRemovePath(pkgName, pkgVersion), method: 'delete', + body: { + force, + }, }); }; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts b/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts index 0d2e1179108f2..3b2b14960379f 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts @@ -109,3 +109,10 @@ export function sendUpgradePackagePolicy(packagePolicyIds: string[]) { }), }); } + +export function sendGetOrphanedIntegrationPolicies() { + return sendRequest({ + path: packagePolicyRouteService.getOrphanedIntegrationPoliciesPath(), + method: 'get', + }); +} diff --git a/x-pack/plugins/fleet/public/search_provider.ts b/x-pack/plugins/fleet/public/search_provider.ts index 9ce1ebc14c5e9..b632c3d1301fc 100644 --- a/x-pack/plugins/fleet/public/search_provider.ts +++ b/x-pack/plugins/fleet/public/search_provider.ts @@ -10,18 +10,17 @@ import type { Observable } from 'rxjs'; import { from, of, combineLatest } from 'rxjs'; import { map, shareReplay, takeUntil } from 'rxjs/operators'; -import { ICON_TYPES } from '@elastic/eui'; - import type { GlobalSearchResultProvider, GlobalSearchProviderResult, } from '@kbn/global-search-plugin/public'; -import { epmRouteService, INTEGRATIONS_PLUGIN_ID } from '../common'; +import { INTEGRATIONS_PLUGIN_ID } from '../common'; import { sendGetPackages } from './hooks'; import type { GetPackagesResponse, PackageListItem } from './types'; import { pagePathGetters } from './constants'; +import { getEuiIconType } from './services/icons'; const packageType = 'integration'; @@ -36,18 +35,6 @@ const createPackages$ = () => shareReplay(1) ); -const getEuiIconType = (pkg: PackageListItem, basePath: IBasePath): string | undefined => { - const pkgIcon = pkg.icons?.find((icon) => icon.type === 'image/svg+xml'); - if (!pkgIcon) { - // If no valid SVG is available, attempt to fallback to built-in EUI icons - return ICON_TYPES.find((key) => key.toLowerCase() === `logo${pkg.name}`); - } - - return basePath.prepend( - epmRouteService.getFilePath(`/package/${pkg.name}/${pkg.version}${pkgIcon.src}`) - ); -}; - /** Exported for testing only @internal */ export const toSearchResult = ( pkg: PackageListItem, diff --git a/x-pack/plugins/fleet/public/services/icons.ts b/x-pack/plugins/fleet/public/services/icons.ts new file mode 100644 index 0000000000000..89287169d7537 --- /dev/null +++ b/x-pack/plugins/fleet/public/services/icons.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ICON_TYPES } from '@elastic/eui'; +import type { IBasePath } from '@kbn/core/public'; + +import { epmRouteService } from '../applications/fleet/services'; +import type { PackageListItem } from '../types'; + +export const getEuiIconType = (pkg: PackageListItem, basePath: IBasePath): string | undefined => { + const pkgIcon = pkg.icons?.find((icon) => icon.type === 'image/svg+xml'); + if (!pkgIcon) { + // If no valid SVG is available, attempt to fallback to built-in EUI icons + return ICON_TYPES.find((key) => key.toLowerCase() === `logo${pkg.name}`); + } + + return basePath.prepend( + epmRouteService.getFilePath(`/package/${pkg.name}/${pkg.version}${pkgIcon.src}`) + ); +}; diff --git a/x-pack/plugins/fleet/server/plugin.ts b/x-pack/plugins/fleet/server/plugin.ts index 51178e80260d4..ae4f6134e891f 100644 --- a/x-pack/plugins/fleet/server/plugin.ts +++ b/x-pack/plugins/fleet/server/plugin.ts @@ -67,6 +67,7 @@ import { registerSettingsRoutes, registerAppRoutes, registerPreconfigurationRoutes, + registerHealthCheckRoutes, } from './routes'; import type { ExternalCallback, FleetRequestHandlerContext } from './types'; @@ -366,6 +367,7 @@ export class FleetPlugin registerSettingsRoutes(fleetAuthzRouter); registerDataStreamRoutes(fleetAuthzRouter); registerPreconfigurationRoutes(fleetAuthzRouter); + registerHealthCheckRoutes(fleetAuthzRouter); // Conditional config routes if (config.agents.enabled) { diff --git a/x-pack/plugins/fleet/server/routes/health_check/index.ts b/x-pack/plugins/fleet/server/routes/health_check/index.ts new file mode 100644 index 0000000000000..23d917aa09a43 --- /dev/null +++ b/x-pack/plugins/fleet/server/routes/health_check/index.ts @@ -0,0 +1,34 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { APP_API_ROUTES } from '../../constants'; +import type { FleetRequestHandler } from '../../types'; +import type { FleetAuthzRouter } from '../security'; + +export const registerRoutes = (router: FleetAuthzRouter) => { + router.get( + { + path: APP_API_ROUTES.HEALTH_CHECK_PATTERN, + validate: {}, + fleetAuthz: { + fleet: { all: true }, + }, + }, + getHealthCheckHandler + ); +}; + +export const getHealthCheckHandler: FleetRequestHandler = async ( + context, + request, + response +) => { + return response.ok({ + body: 'Fleet Health Check Report:\nFleet Server: HEALTHY', + headers: { 'content-type': 'text/plain' }, + }); +}; diff --git a/x-pack/plugins/fleet/server/routes/index.ts b/x-pack/plugins/fleet/server/routes/index.ts index bcdc2db54ae0c..b04e179a05dcf 100644 --- a/x-pack/plugins/fleet/server/routes/index.ts +++ b/x-pack/plugins/fleet/server/routes/index.ts @@ -16,3 +16,4 @@ export { registerRoutes as registerOutputRoutes } from './output'; export { registerRoutes as registerSettingsRoutes } from './settings'; export { registerRoutes as registerAppRoutes } from './app'; export { registerRoutes as registerPreconfigurationRoutes } from './preconfiguration'; +export { registerRoutes as registerHealthCheckRoutes } from './health_check'; diff --git a/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts b/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts index ad46f25ff91de..c6f9e1583841b 100644 --- a/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts +++ b/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts @@ -11,7 +11,9 @@ import Boom from '@hapi/boom'; import { SavedObjectsErrorHelpers } from '@kbn/core/server'; import type { RequestHandler } from '@kbn/core/server'; -import { appContextService, packagePolicyService } from '../../services'; +import { groupBy, keyBy } from 'lodash'; + +import { agentPolicyService, appContextService, packagePolicyService } from '../../services'; import type { GetPackagePoliciesRequestSchema, GetOnePackagePolicyRequestSchema, @@ -21,6 +23,7 @@ import type { UpgradePackagePoliciesRequestSchema, DryRunPackagePoliciesRequestSchema, FleetRequestHandler, + PackagePolicy, } from '../../types'; import type { CreatePackagePolicyResponse, @@ -29,7 +32,10 @@ import type { UpgradePackagePolicyDryRunResponse, UpgradePackagePolicyResponse, } from '../../../common'; +import { installationStatuses } from '../../../common'; import { defaultIngestErrorHandler } from '../../errors'; +import { getInstallations } from '../../services/epm/packages'; +import { PACKAGES_SAVED_OBJECT_TYPE, SO_SEARCH_LIMIT } from '../../constants'; export const getPackagePoliciesHandler: RequestHandler< undefined, @@ -82,6 +88,50 @@ export const getOnePackagePolicyHandler: RequestHandler< } }; +export const getOrphanedPackagePolicies: RequestHandler = async ( + context, + request, + response +) => { + const soClient = (await context.core).savedObjects.client; + try { + const installedPackages = await getInstallations(soClient, { + perPage: SO_SEARCH_LIMIT, + filter: ` + ${PACKAGES_SAVED_OBJECT_TYPE}.attributes.install_status:${installationStatuses.Installed} + `, + }); + const orphanedPackagePolicies: PackagePolicy[] = []; + const packagePolicies = await packagePolicyService.list(soClient, { + perPage: SO_SEARCH_LIMIT, + }); + const packagePoliciesByPackage = groupBy(packagePolicies.items, 'package.name'); + const agentPolicies = await agentPolicyService.list(soClient, { + perPage: SO_SEARCH_LIMIT, + }); + const agentPoliciesById = keyBy(agentPolicies.items, 'id'); + const usedPackages = installedPackages.saved_objects.filter( + ({ attributes: { name } }) => !!packagePoliciesByPackage[name] + ); + usedPackages.forEach(({ attributes: { name } }) => { + packagePoliciesByPackage[name].forEach((packagePolicy) => { + if (!agentPoliciesById[packagePolicy.policy_id]) { + orphanedPackagePolicies.push(packagePolicy); + } + }); + }); + + return response.ok({ + body: { + items: orphanedPackagePolicies, + total: orphanedPackagePolicies.length, + }, + }); + } catch (error) { + return defaultIngestErrorHandler({ error, response }); + } +}; + export const createPackagePolicyHandler: FleetRequestHandler< undefined, undefined, @@ -218,7 +268,7 @@ export const deletePackagePolicyHandler: RequestHandler< soClient, esClient, request.body.packagePolicyIds, - { user, force: request.body.force } + { user, force: request.body.force, skipUnassignFromAgentPolicies: request.body.force } ); try { await packagePolicyService.runExternalCallbacks( diff --git a/x-pack/plugins/fleet/server/routes/package_policy/index.ts b/x-pack/plugins/fleet/server/routes/package_policy/index.ts index 68cdfc26df531..2b2ae190b80bb 100644 --- a/x-pack/plugins/fleet/server/routes/package_policy/index.ts +++ b/x-pack/plugins/fleet/server/routes/package_policy/index.ts @@ -25,6 +25,7 @@ import { deletePackagePolicyHandler, upgradePackagePolicyHandler, dryRunUpgradePackagePolicyHandler, + getOrphanedPackagePolicies, } from './handlers'; export const registerRoutes = (router: FleetAuthzRouter) => { @@ -52,6 +53,17 @@ export const registerRoutes = (router: FleetAuthzRouter) => { getOnePackagePolicyHandler ); + router.get( + { + path: PACKAGE_POLICY_API_ROUTES.ORPHANED_INTEGRATION_POLICIES, + validate: {}, + fleetAuthz: { + integrations: { readIntegrationPolicies: true }, + }, + }, + getOrphanedPackagePolicies + ); + // Create router.post( { diff --git a/x-pack/plugins/fleet/server/services/agents/agent_service.test.ts b/x-pack/plugins/fleet/server/services/agents/agent_service.test.ts index 3a49fb99dfb0e..be4ca37260b8a 100644 --- a/x-pack/plugins/fleet/server/services/agents/agent_service.test.ts +++ b/x-pack/plugins/fleet/server/services/agents/agent_service.test.ts @@ -149,7 +149,9 @@ function expectApisToCallServicesSuccessfully( await expect(agentClient.listAgents({ showInactive: true })).resolves.toEqual( 'getAgentsByKuery success' ); - expect(mockGetAgentsByKuery).toHaveBeenCalledWith(mockEsClient, { showInactive: true }); + expect(mockGetAgentsByKuery).toHaveBeenCalledWith(mockEsClient, { + showInactive: true, + }); }); test('client.getAgent calls getAgentById and returns results', async () => { diff --git a/x-pack/plugins/fleet/server/services/agents/hosted_agent.test.ts b/x-pack/plugins/fleet/server/services/agents/hosted_agent.test.ts new file mode 100644 index 0000000000000..997bb0817351c --- /dev/null +++ b/x-pack/plugins/fleet/server/services/agents/hosted_agent.test.ts @@ -0,0 +1,63 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { savedObjectsClientMock } from '@kbn/core/server/mocks'; + +import type { Agent } from '../../types'; + +import { getHostedPolicies, isHostedAgent } from './hosted_agent'; + +jest.mock('../agent_policy', () => { + return { + agentPolicyService: { + getByIDs: jest.fn().mockResolvedValue([ + { id: 'hosted-policy', is_managed: true }, + { id: 'regular-policy', is_managed: false }, + ]), + }, + }; +}); + +describe('hosted agent helpers', () => { + const soClientMock = savedObjectsClientMock.create(); + const expectedHostedPolicies = { + 'hosted-policy': true, + 'regular-policy': false, + }; + + it('should query unique managed policies', async () => { + const result = await getHostedPolicies(soClientMock, [ + { policy_id: 'hosted-policy' } as Agent, + { policy_id: 'hosted-policy' } as Agent, + { policy_id: 'regular-policy' } as Agent, + { policy_id: 'regular-policy' } as Agent, + ]); + expect(result).toEqual(expectedHostedPolicies); + }); + + it('should return true for hosted policy', () => { + const isHosted = isHostedAgent(expectedHostedPolicies, { policy_id: 'hosted-policy' } as Agent); + expect(isHosted).toBeTruthy(); + }); + + it('should return false for regular policy', () => { + const isHosted = isHostedAgent(expectedHostedPolicies, { + policy_id: 'regular-policy', + } as Agent); + expect(isHosted).toBeFalsy(); + }); + + it('should return false for missing policy_id', () => { + const isHosted = isHostedAgent(expectedHostedPolicies, {} as Agent); + expect(isHosted).toBeFalsy(); + }); + + it('should return false for non existing policy', () => { + const isHosted = isHostedAgent(expectedHostedPolicies, { policy_id: 'dummy-policy' } as Agent); + expect(isHosted).toBeFalsy(); + }); +}); diff --git a/x-pack/plugins/fleet/server/services/agents/hosted_agent.ts b/x-pack/plugins/fleet/server/services/agents/hosted_agent.ts new file mode 100644 index 0000000000000..0c26e09575ac3 --- /dev/null +++ b/x-pack/plugins/fleet/server/services/agents/hosted_agent.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { SavedObjectsClientContract } from '@kbn/core/server'; + +import type { Agent } from '../../types'; +import { agentPolicyService } from '../agent_policy'; + +export async function getHostedPolicies( + soClient: SavedObjectsClientContract, + agents: Agent[] +): Promise<{ [key: string]: boolean }> { + // get any policy ids from upgradable agents + const policyIdsToGet = new Set( + agents.filter((agent) => agent.policy_id).map((agent) => agent.policy_id!) + ); + + // get the agent policies for those ids + const agentPolicies = await agentPolicyService.getByIDs(soClient, Array.from(policyIdsToGet), { + fields: ['is_managed'], + }); + const hostedPolicies = agentPolicies.reduce>((acc, policy) => { + acc[policy.id] = policy.is_managed; + return acc; + }, {}); + + return hostedPolicies; +} + +export function isHostedAgent(hostedPolicies: { [key: string]: boolean }, agent: Agent) { + return agent.policy_id && hostedPolicies[agent.policy_id]; +} diff --git a/x-pack/plugins/fleet/server/services/agents/reassign.ts b/x-pack/plugins/fleet/server/services/agents/reassign.ts index c842bfb8f72c7..e077e7e47294b 100644 --- a/x-pack/plugins/fleet/server/services/agents/reassign.ts +++ b/x-pack/plugins/fleet/server/services/agents/reassign.ts @@ -22,6 +22,7 @@ import { import type { GetAgentsOptions } from '.'; import { createAgentAction } from './actions'; import { searchHitToAgent } from './helpers'; +import { getHostedPolicies, isHostedAgent } from './hosted_agent'; export async function reassignAgent( soClient: SavedObjectsClientContract, @@ -80,10 +81,15 @@ export async function reassignAgents( options: ({ agents: Agent[] } | GetAgentsOptions) & { force?: boolean }, newAgentPolicyId: string ): Promise<{ items: BulkActionResult[] }> { - const agentPolicy = await agentPolicyService.get(soClient, newAgentPolicyId); - if (!agentPolicy) { + const newAgentPolicy = await agentPolicyService.get(soClient, newAgentPolicyId); + if (!newAgentPolicy) { throw Boom.notFound(`Agent policy not found: ${newAgentPolicyId}`); } + if (newAgentPolicy.is_managed) { + throw new HostedAgentPolicyRestrictionRelatedError( + `Cannot reassign an agent to hosted agent policy ${newAgentPolicy.id}` + ); + } const outgoingErrors: Record = {}; let givenAgents: Agent[] = []; @@ -106,6 +112,8 @@ export async function reassignAgents( const givenOrder = 'agentIds' in options ? options.agentIds : givenAgents.map((agent) => agent.id); + const hostedPolicies = await getHostedPolicies(soClient, givenAgents); + // which are allowed to unenroll const agentResults = await Promise.allSettled( givenAgents.map(async (agent, index) => { @@ -113,16 +121,13 @@ export async function reassignAgents( throw new AgentReassignmentError(`${agent.id} is already assigned to ${newAgentPolicyId}`); } - const isAllowed = await reassignAgentIsAllowed( - soClient, - esClient, - agent.id, - newAgentPolicyId - ); - if (isAllowed) { - return agent; + if (isHostedAgent(hostedPolicies, agent)) { + throw new HostedAgentPolicyRestrictionRelatedError( + `Cannot reassign an agent from hosted agent policy ${agent.policy_id}` + ); } - throw new AgentReassignmentError(`${agent.id} may not be reassigned to ${newAgentPolicyId}`); + + return agent; }) ); diff --git a/x-pack/plugins/fleet/server/services/agents/unenroll.ts b/x-pack/plugins/fleet/server/services/agents/unenroll.ts index 92dd0f1ba22f8..893fb5f20c76a 100644 --- a/x-pack/plugins/fleet/server/services/agents/unenroll.ts +++ b/x-pack/plugins/fleet/server/services/agents/unenroll.ts @@ -20,6 +20,7 @@ import { getAgentPolicyForAgent, bulkUpdateAgents, } from './crud'; +import { getHostedPolicies, isHostedAgent } from './hosted_agent'; async function unenrollAgentIsAllowed( soClient: SavedObjectsClientContract, @@ -80,21 +81,22 @@ export async function unenrollAgents( } return !agent.unenrollment_started_at && !agent.unenrolled_at; }); - // And which are allowed to unenroll - const agentResults = await Promise.allSettled( - agentsEnrolled.map((agent) => - unenrollAgentIsAllowed(soClient, esClient, agent.id).then((_) => agent) - ) - ); + + const hostedPolicies = await getHostedPolicies(soClient, agentsEnrolled); + const outgoingErrors: Record = {}; + + // And which are allowed to unenroll const agentsToUpdate = options.force ? agentsEnrolled - : agentResults.reduce((agents, result, index) => { - if (result.status === 'fulfilled') { - agents.push(result.value); - } else { + : agentsEnrolled.reduce((agents, agent, index) => { + if (isHostedAgent(hostedPolicies, agent)) { const id = givenAgents[index].id; - outgoingErrors[id] = result.reason; + outgoingErrors[id] = new HostedAgentPolicyRestrictionRelatedError( + `Cannot unenroll ${agent.id} from a hosted agent policy ${agent.policy_id}` + ); + } else { + agents.push(agent); } return agents; }, []); diff --git a/x-pack/plugins/fleet/server/services/agents/upgrade.ts b/x-pack/plugins/fleet/server/services/agents/upgrade.ts index 2c839bdd7bb09..f5db132815fb7 100644 --- a/x-pack/plugins/fleet/server/services/agents/upgrade.ts +++ b/x-pack/plugins/fleet/server/services/agents/upgrade.ts @@ -10,7 +10,6 @@ import moment from 'moment'; import pMap from 'p-map'; import type { Agent, BulkActionResult, FleetServerAgentAction, CurrentUpgrade } from '../../types'; -import { agentPolicyService } from '..'; import { AgentReassignmentError, HostedAgentPolicyRestrictionRelatedError, @@ -30,6 +29,7 @@ import { getAgentPolicyForAgent, } from './crud'; import { searchHitToAgent } from './helpers'; +import { getHostedPolicies, isHostedAgent } from './hosted_agent'; const MINIMUM_EXECUTION_DURATION_SECONDS = 1800; // 30m @@ -107,26 +107,13 @@ export async function sendUpgradeAgentsActions( givenAgents = await getAgents(esClient, options); } - // get any policy ids from upgradable agents - const policyIdsToGet = new Set( - givenAgents.filter((agent) => agent.policy_id).map((agent) => agent.policy_id!) - ); - - // get the agent policies for those ids - const agentPolicies = await agentPolicyService.getByIDs(soClient, Array.from(policyIdsToGet), { - fields: ['is_managed'], - }); - const hostedPolicies = agentPolicies.reduce>((acc, policy) => { - acc[policy.id] = policy.is_managed; - return acc; - }, {}); - const isHostedAgent = (agent: Agent) => agent.policy_id && hostedPolicies[agent.policy_id]; + const hostedPolicies = await getHostedPolicies(soClient, givenAgents); // results from getAgents with options.kuery '' (or even 'active:false') may include hosted agents // filter them out unless options.force const agentsToCheckUpgradeable = 'kuery' in options && !options.force - ? givenAgents.filter((agent: Agent) => !isHostedAgent(agent)) + ? givenAgents.filter((agent: Agent) => !isHostedAgent(hostedPolicies, agent)) : givenAgents; const kibanaVersion = appContextService.getKibanaVersion(); @@ -139,7 +126,7 @@ export async function sendUpgradeAgentsActions( throw new IngestManagerError(`${agent.id} is not upgradeable`); } - if (!options.force && isHostedAgent(agent)) { + if (!options.force && isHostedAgent(hostedPolicies, agent)) { throw new HostedAgentPolicyRestrictionRelatedError( `Cannot upgrade agent in hosted agent policy ${agent.policy_id}` ); diff --git a/x-pack/plugins/fleet/server/services/epm/archive/index.test.ts b/x-pack/plugins/fleet/server/services/epm/archive/index.test.ts new file mode 100644 index 0000000000000..ab2bb44621b0e --- /dev/null +++ b/x-pack/plugins/fleet/server/services/epm/archive/index.test.ts @@ -0,0 +1,89 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { AssetParts } from '../../../types'; + +import { getBufferExtractor, getPathParts, untarBuffer, unzipBuffer } from '.'; + +describe('getPathParts', () => { + const testPaths = [ + { + path: 'foo-1.1.0/service/type/file.yml', + assetParts: { + dataset: undefined, + file: 'file.yml', + path: 'foo-1.1.0/service/type/file.yml', + pkgkey: 'foo-1.1.0', + service: 'service', + type: 'type', + }, + }, + { + path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', + assetParts: { + dataset: undefined, + file: '683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', + path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', + pkgkey: 'iptables-1.0.4', + service: 'kibana', + type: 'visualization', + }, + }, + { + path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml', + assetParts: { + dataset: 'stats', + file: 'coredns.stats.yml', + path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml', + pkgkey: 'coredns-1.0.1', + service: '', + type: 'fields', + }, + }, + ]; + test('testPathParts', () => { + for (const value of testPaths) { + expect(getPathParts(value.path)).toStrictEqual(value.assetParts as AssetParts); + } + }); +}); + +describe('getBufferExtractor called with { archivePath }', () => { + it('returns unzipBuffer if `archivePath` ends in .zip', () => { + const extractor = getBufferExtractor({ archivePath: '.zip' }); + expect(extractor).toBe(unzipBuffer); + }); + + it('returns untarBuffer if `archivePath` ends in .gz', () => { + const extractor = getBufferExtractor({ archivePath: '.gz' }); + expect(extractor).toBe(untarBuffer); + const extractor2 = getBufferExtractor({ archivePath: '.tar.gz' }); + expect(extractor2).toBe(untarBuffer); + }); + + it('returns `undefined` if `archivePath` ends in anything else', () => { + const extractor = getBufferExtractor({ archivePath: '.xyz' }); + expect(extractor).toEqual(undefined); + }); +}); + +describe('getBufferExtractor called with { contentType }', () => { + it('returns unzipBuffer if `contentType` is `application/zip`', () => { + const extractor = getBufferExtractor({ contentType: 'application/zip' }); + expect(extractor).toBe(unzipBuffer); + }); + + it('returns untarBuffer if `contentType` is `application/gzip`', () => { + const extractor = getBufferExtractor({ contentType: 'application/gzip' }); + expect(extractor).toBe(untarBuffer); + }); + + it('returns `undefined` if `contentType` ends in anything else', () => { + const extractor = getBufferExtractor({ contentType: '.xyz' }); + expect(extractor).toEqual(undefined); + }); +}); diff --git a/x-pack/plugins/fleet/server/services/epm/registry/index.test.ts b/x-pack/plugins/fleet/server/services/epm/registry/index.test.ts index 62ea278734795..e9427732d4aef 100644 --- a/x-pack/plugins/fleet/server/services/epm/registry/index.test.ts +++ b/x-pack/plugins/fleet/server/services/epm/registry/index.test.ts @@ -5,54 +5,35 @@ * 2.0. */ -import type { AssetParts } from '../../../types'; -import { getBufferExtractor, getPathParts, untarBuffer, unzipBuffer } from '../archive'; - -import { splitPkgKey } from '.'; - -const testPaths = [ - { - path: 'foo-1.1.0/service/type/file.yml', - assetParts: { - dataset: undefined, - file: 'file.yml', - path: 'foo-1.1.0/service/type/file.yml', - pkgkey: 'foo-1.1.0', - service: 'service', - type: 'type', - }, - }, - { - path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', - assetParts: { - dataset: undefined, - file: '683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', - path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json', - pkgkey: 'iptables-1.0.4', - service: 'kibana', - type: 'visualization', - }, - }, - { - path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml', - assetParts: { - dataset: 'stats', - file: 'coredns.stats.yml', - path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml', - pkgkey: 'coredns-1.0.1', - service: '', - type: 'fields', - }, +import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; + +import { PackageNotFoundError } from '../../../errors'; + +import { splitPkgKey, fetchFindLatestPackageOrUndefined, fetchFindLatestPackageOrThrow } from '.'; + +const mockLoggerFactory = loggingSystemMock.create(); +const mockLogger = mockLoggerFactory.get('mock logger'); + +const mockGetBundledPackageByName = jest.fn(); +const mockFetchUrl = jest.fn(); +jest.mock('../..', () => ({ + appContextService: { + getLogger: () => mockLogger, + getKibanaBranch: () => 'main', + getKibanaVersion: () => '99.0.0', + getConfig: () => ({}), }, -]; +})); -test('testPathParts', () => { - for (const value of testPaths) { - expect(getPathParts(value.path)).toStrictEqual(value.assetParts as AssetParts); - } -}); +jest.mock('./requests', () => ({ + fetchUrl: (url: string) => mockFetchUrl(url), +})); -describe('splitPkgKey tests', () => { +jest.mock('../packages/bundled_packages', () => ({ + getBundledPackageByName: (name: string) => mockGetBundledPackageByName(name), +})); + +describe('splitPkgKey', () => { it('throws an error if there is nothing before the delimiter', () => { expect(() => { splitPkgKey('-0.0.1-dev1'); @@ -84,38 +65,81 @@ describe('splitPkgKey tests', () => { }); }); -describe('getBufferExtractor called with { archivePath }', () => { - it('returns unzipBuffer if `archivePath` ends in .zip', () => { - const extractor = getBufferExtractor({ archivePath: '.zip' }); - expect(extractor).toBe(unzipBuffer); +describe('fetch package', () => { + afterEach(() => { + mockFetchUrl.mockReset(); + mockGetBundledPackageByName.mockReset(); }); - it('returns untarBuffer if `archivePath` ends in .gz', () => { - const extractor = getBufferExtractor({ archivePath: '.gz' }); - expect(extractor).toBe(untarBuffer); - const extractor2 = getBufferExtractor({ archivePath: '.tar.gz' }); - expect(extractor2).toBe(untarBuffer); - }); + type FetchFn = typeof fetchFindLatestPackageOrThrow | typeof fetchFindLatestPackageOrUndefined; + const performGenericFetchTests = (fetchMethodToTest: FetchFn) => { + it('Should return registry package if bundled package is older version', async () => { + const bundledPackage = { name: 'testpkg', version: '1.0.0' }; + const registryPackage = { name: 'testpkg', version: '1.0.1' }; - it('returns `undefined` if `archivePath` ends in anything else', () => { - const extractor = getBufferExtractor({ archivePath: '.xyz' }); - expect(extractor).toEqual(undefined); - }); -}); + mockFetchUrl.mockResolvedValue(JSON.stringify([registryPackage])); -describe('getBufferExtractor called with { contentType }', () => { - it('returns unzipBuffer if `contentType` is `application/zip`', () => { - const extractor = getBufferExtractor({ contentType: 'application/zip' }); - expect(extractor).toBe(unzipBuffer); - }); + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + const result = await fetchMethodToTest('testpkg'); + expect(result).toEqual(registryPackage); + }); + + it('Should return bundled package if bundled package is newer version', async () => { + const bundledPackage = { name: 'testpkg', version: '1.0.1' }; + const registryPackage = { name: 'testpkg', version: '1.0.0' }; - it('returns untarBuffer if `contentType` is `application/gzip`', () => { - const extractor = getBufferExtractor({ contentType: 'application/gzip' }); - expect(extractor).toBe(untarBuffer); + mockFetchUrl.mockResolvedValue(JSON.stringify([registryPackage])); + + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + const result = await fetchMethodToTest('testpkg'); + expect(result).toEqual(bundledPackage); + }); + it('Should return bundled package if there is no registry package', async () => { + const bundledPackage = { name: 'testpkg', version: '1.0.1' }; + + mockFetchUrl.mockResolvedValue(JSON.stringify([])); + + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + const result = await fetchMethodToTest('testpkg'); + expect(result).toEqual(bundledPackage); + }); + + it('Should fall back to bundled package if there is an error getting from the registry', async () => { + const bundledPackage = { name: 'testpkg', version: '1.0.1' }; + + mockFetchUrl.mockRejectedValue(new Error('Registry error')); + + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + const result = await fetchMethodToTest('testpkg'); + expect(result).toEqual(bundledPackage); + }); + }; + + describe('fetchFindLatestPackageOrUndefined', () => { + performGenericFetchTests(fetchFindLatestPackageOrUndefined); + it('Should return undefined if there is a registry error and no bundled package', async () => { + const bundledPackage = null; + + mockFetchUrl.mockRejectedValue(new Error('Registry error')); + + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + const result = await fetchFindLatestPackageOrUndefined('testpkg'); + expect(result).toEqual(undefined); + }); }); - it('returns `undefined` if `contentType` ends in anything else', () => { - const extractor = getBufferExtractor({ contentType: '.xyz' }); - expect(extractor).toEqual(undefined); + describe('fetchFindLatestPackageOrThrow', () => { + performGenericFetchTests(fetchFindLatestPackageOrThrow); + it('Should return undefined if there is a registry error and no bundled package', async () => { + const bundledPackage = null; + + mockFetchUrl.mockRejectedValue(new Error('Registry error')); + + mockGetBundledPackageByName.mockResolvedValue(bundledPackage); + + expect(() => fetchFindLatestPackageOrThrow('testpkg')).rejects.toBeInstanceOf( + PackageNotFoundError + ); + }); }); }); diff --git a/x-pack/plugins/graph/public/components/search_bar.tsx b/x-pack/plugins/graph/public/components/search_bar.tsx index 046ed05977c79..4eccff31c644b 100644 --- a/x-pack/plugins/graph/public/components/search_bar.tsx +++ b/x-pack/plugins/graph/public/components/search_bar.tsx @@ -10,9 +10,9 @@ import React, { useState, useEffect } from 'react'; import { i18n } from '@kbn/i18n'; import { connect } from 'react-redux'; -import { toElasticsearchQuery, fromKueryExpression } from '@kbn/es-query'; +import { toElasticsearchQuery, fromKueryExpression, Query } from '@kbn/es-query'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { IDataPluginServices, Query } from '@kbn/data-plugin/public'; +import { IDataPluginServices } from '@kbn/data-plugin/public'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { IndexPatternSavedObject, IndexPatternProvider, WorkspaceField } from '../types'; diff --git a/x-pack/plugins/graph/public/components/settings/settings.tsx b/x-pack/plugins/graph/public/components/settings/settings.tsx index d8f18add4f375..6b96800f6d2eb 100644 --- a/x-pack/plugins/graph/public/components/settings/settings.tsx +++ b/x-pack/plugins/graph/public/components/settings/settings.tsx @@ -105,10 +105,11 @@ export function SettingsComponent({ {tabs .filter(({ id }) => id !== 'drillDowns' || workspaceProps.canEditDrillDownUrls) - .map(({ title }, index) => ( + .map(({ title, id }, index) => ( { setActiveTab(index); }} diff --git a/x-pack/plugins/graph/public/components/settings/url_template_form.tsx b/x-pack/plugins/graph/public/components/settings/url_template_form.tsx index e05685be3e660..57e69d0912a7f 100644 --- a/x-pack/plugins/graph/public/components/settings/url_template_form.tsx +++ b/x-pack/plugins/graph/public/components/settings/url_template_form.tsx @@ -264,6 +264,7 @@ export function UrlTemplateForm(props: UrlTemplateFormProps) {
{urlTemplateIconChoices.map((icon) => ( { run: () => { props.setShowInspect((prevShowInspect) => !prevShowInspect); }, + testId: 'graphInspectButton', }); topNavMenu.push({ @@ -164,6 +165,7 @@ export const WorkspaceTopNavMenu = (props: WorkspaceTopNavMenuProps) => { } ); }, + testId: 'graphSettingsButton', }); return ( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx index bff812e7e7601..4ead102c9bae8 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx @@ -111,7 +111,7 @@ function createFetchMock(): NodeMetricsTableFetchMock { function createContainer( name: string, - uptimeMs: number, + startTime: number, cpuUsagePct: number, memoryUsageBytes: number ): Partial { @@ -119,8 +119,8 @@ function createContainer( id: name, rows: [ { - [metricByField['kubernetes.container.start_time']]: uptimeMs, - [metricByField['kubernetes.container.cpu.usage.node.pct']]: cpuUsagePct, + [metricByField['kubernetes.container.start_time']]: startTime, + [metricByField['kubernetes.container.cpu.usage.limit.pct']]: cpuUsagePct, [metricByField['kubernetes.container.memory.usage.bytes']]: memoryUsageBytes, } as MetricsExplorerSeries['rows'][number], ], diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx index 3ad7d18bc221c..445bfd7c107fb 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx @@ -17,9 +17,10 @@ import { EuiLoadingSpinner, EuiSpacer, } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; import React, { useCallback, useMemo } from 'react'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; import type { SortState } from '../shared'; +import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; import type { ContainerNodeMetricsRow } from './use_container_metrics_table'; export interface ContainerMetricsTableProps { @@ -78,7 +79,9 @@ export const ContainerMetricsTable = (props: ContainerMetricsTableProps) => { return ( <> { > { return [ { - name: 'Name', + name: i18n.translate('xpack.infra.metricsTable.container.nameColumnHeader', { + defaultMessage: 'Name', + }), field: 'name', truncateText: true, textOnly: true, @@ -122,13 +129,20 @@ function containerNodeColumns( }, }, { - name: 'Uptime', + name: i18n.translate('xpack.infra.metricsTable.container.uptimeColumnHeader', { + defaultMessage: 'Uptime', + }), field: 'uptime', align: 'right', render: (uptime: number) => , }, { - name: 'CPU usage (avg.)', + name: i18n.translate( + 'xpack.infra.metricsTable.container.averageCpuUsagePercentColumnHeader', + { + defaultMessage: 'CPU usage (avg.)', + } + ), field: 'averageCpuUsagePercent', align: 'right', render: (averageCpuUsagePercent: number) => ( @@ -136,7 +150,12 @@ function containerNodeColumns( ), }, { - name: 'Memory usage(avg.)', + name: i18n.translate( + 'xpack.infra.metricsTable.container.averageMemoryUsageMegabytesColumnHeader', + { + defaultMessage: 'Memory usage(avg.)', + } + ), field: 'averageMemoryUsageMegabytes', align: 'right', render: (averageMemoryUsageMegabytes: number) => ( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts index 40cb1e0ee2763..6fea0b399b425 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts @@ -12,14 +12,17 @@ import type { } from '../../../../common/http_api/metrics_explorer'; import type { MetricsQueryOptions, SortState, UseNodeMetricsTableOptions } from '../shared'; import { + averageOfValues, + createMetricByFieldLookup, + makeUnpackMetric, metricsToApiOptions, + scaleUpPercentage, useInfrastructureNodeMetrics, - createMetricByFieldLookup, } from '../shared'; type ContainerMetricsField = | 'kubernetes.container.start_time' - | 'kubernetes.container.cpu.usage.node.pct' + | 'kubernetes.container.cpu.usage.limit.pct' | 'kubernetes.container.memory.usage.bytes'; const containerMetricsQueryConfig: MetricsQueryOptions = { @@ -34,9 +37,9 @@ const containerMetricsQueryConfig: MetricsQueryOptions = aggregation: 'max', field: 'kubernetes.container.start_time', }, - 'kubernetes.container.cpu.usage.node.pct': { + 'kubernetes.container.cpu.usage.limit.pct': { aggregation: 'avg', - field: 'kubernetes.container.cpu.usage.node.pct', + field: 'kubernetes.container.cpu.usage.limit.pct', }, 'kubernetes.container.memory.usage.bytes': { aggregation: 'avg', @@ -46,6 +49,7 @@ const containerMetricsQueryConfig: MetricsQueryOptions = }; export const metricByField = createMetricByFieldLookup(containerMetricsQueryConfig.metricsMap); +const unpackMetric = makeUnpackMetric(metricByField); export interface ContainerNodeMetricsRow { name: string; @@ -114,17 +118,18 @@ function rowWithoutMetrics(name: string) { } function calculateMetricAverages(rows: MetricsExplorerRow[]) { - const { uptimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues } = + const { startTimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues } = collectMetricValues(rows); let uptime = null; - if (uptimeValues.length !== 0) { - uptime = averageOfValues(uptimeValues); + if (startTimeValues.length !== 0) { + const startTime = startTimeValues.at(-1); + uptime = Date.now() - startTime!; } let averageCpuUsagePercent = null; if (averageCpuUsagePercentValues.length !== 0) { - averageCpuUsagePercent = averageOfValues(averageCpuUsagePercentValues); + averageCpuUsagePercent = scaleUpPercentage(averageOfValues(averageCpuUsagePercentValues)); } let averageMemoryUsageMegabytes = null; @@ -142,15 +147,15 @@ function calculateMetricAverages(rows: MetricsExplorerRow[]) { } function collectMetricValues(rows: MetricsExplorerRow[]) { - const uptimeValues: number[] = []; + const startTimeValues: number[] = []; const averageCpuUsagePercentValues: number[] = []; const averageMemoryUsageMegabytesValues: number[] = []; rows.forEach((row) => { - const { uptime, averageCpuUsagePercent, averageMemoryUsageMegabytes } = unpackMetrics(row); + const { startTime, averageCpuUsagePercent, averageMemoryUsageMegabytes } = unpackMetrics(row); - if (uptime !== null) { - uptimeValues.push(uptime); + if (startTime !== null) { + startTimeValues.push(startTime); } if (averageCpuUsagePercent !== null) { @@ -163,25 +168,18 @@ function collectMetricValues(rows: MetricsExplorerRow[]) { }); return { - uptimeValues, + startTimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues, }; } -function unpackMetrics(row: MetricsExplorerRow): Omit { +function unpackMetrics( + row: MetricsExplorerRow +): Omit & { startTime: number | null } { return { - uptime: row[metricByField['kubernetes.container.start_time']] as number | null, - averageCpuUsagePercent: row[metricByField['kubernetes.container.cpu.usage.node.pct']] as - | number - | null, - averageMemoryUsageMegabytes: row[metricByField['kubernetes.container.memory.usage.bytes']] as - | number - | null, + startTime: unpackMetric(row, 'kubernetes.container.start_time'), + averageCpuUsagePercent: unpackMetric(row, 'kubernetes.container.cpu.usage.limit.pct'), + averageMemoryUsageMegabytes: unpackMetric(row, 'kubernetes.container.memory.usage.bytes'), }; } - -function averageOfValues(values: number[]) { - const sum = values.reduce((acc, value) => acc + value, 0); - return sum / values.length; -} diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx index 652af65e02a23..043d9411bf284 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx @@ -17,9 +17,10 @@ import { EuiLoadingSpinner, EuiSpacer, } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; import React, { useCallback, useMemo } from 'react'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination } from '../shared'; import type { SortState } from '../shared'; +import { MetricsNodeDetailsLink, NumberCell, StepwisePagination } from '../shared'; import type { HostNodeMetricsRow } from './use_host_metrics_table'; export interface HostMetricsTableProps { @@ -78,7 +79,9 @@ export const HostMetricsTable = (props: HostMetricsTableProps) => { return ( <> { > { return [ { - name: 'Name', + name: i18n.translate('xpack.infra.metricsTable.host.nameColumnHeader', { + defaultMessage: 'Name', + }), field: 'name', truncateText: true, textOnly: true, @@ -115,13 +122,17 @@ function hostMetricsColumns( ), }, { - name: '# of CPUs', + name: i18n.translate('xpack.infra.metricsTable.host.CpuCountColumnHeader', { + defaultMessage: '# of CPUs', + }), field: 'cpuCount', align: 'right', render: (cpuCount: number) => , }, { - name: 'CPU usage (avg.)', + name: i18n.translate('xpack.infra.metricsTable.host.averageCpuUsagePercentColumnHeader', { + defaultMessage: 'CPU usage (avg.)', + }), field: 'averageCpuUsagePercent', align: 'right', render: (averageCpuUsagePercent: number) => ( @@ -129,7 +140,9 @@ function hostMetricsColumns( ), }, { - name: 'Memory total (avg.)', + name: i18n.translate('xpack.infra.metricsTable.host.totalMemoryMegabytesColumnHeader', { + defaultMessage: 'Memory total', + }), field: 'totalMemoryMegabytes', align: 'right', render: (totalMemoryMegabytes: number) => ( @@ -137,7 +150,9 @@ function hostMetricsColumns( ), }, { - name: 'Memory usage (avg.)', + name: i18n.translate('xpack.infra.metricsTable.host.averageMemoryUsagePercentColumnHeader', { + defaultMessage: 'Memory usage (avg.)', + }), field: 'averageMemoryUsagePercent', align: 'right', render: (averageMemoryUsagePercent: number) => ( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts index 04212ce9c215b..602b5e519d25d 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts @@ -12,9 +12,12 @@ import type { } from '../../../../common/http_api/metrics_explorer'; import type { MetricsQueryOptions, SortState, UseNodeMetricsTableOptions } from '../shared'; import { + averageOfValues, + createMetricByFieldLookup, + makeUnpackMetric, metricsToApiOptions, + scaleUpPercentage, useInfrastructureNodeMetrics, - createMetricByFieldLookup, } from '../shared'; type HostMetricsField = @@ -45,6 +48,7 @@ const hostsMetricsQueryConfig: MetricsQueryOptions = { }; export const metricByField = createMetricByFieldLookup(hostsMetricsQueryConfig.metricsMap); +const unpackMetric = makeUnpackMetric(metricByField); export interface HostNodeMetricsRow { name: string; @@ -121,24 +125,24 @@ function calculateMetricAverages(rows: MetricsExplorerRow[]) { let cpuCount = null; if (cpuCountValues.length !== 0) { - cpuCount = averageOfValues(cpuCountValues); + cpuCount = cpuCountValues.at(-1)!; } let averageCpuUsagePercent = null; if (averageCpuUsagePercentValues.length !== 0) { - averageCpuUsagePercent = averageOfValues(averageCpuUsagePercentValues); + averageCpuUsagePercent = scaleUpPercentage(averageOfValues(averageCpuUsagePercentValues)); } let totalMemoryMegabytes = null; if (totalMemoryMegabytesValues.length !== 0) { - const averageInBytes = averageOfValues(totalMemoryMegabytesValues); + const memoryInBytes = totalMemoryMegabytesValues.at(-1); const bytesPerMegabyte = 1000000; - totalMemoryMegabytes = Math.floor(averageInBytes / bytesPerMegabyte); + totalMemoryMegabytes = Math.floor(memoryInBytes! / bytesPerMegabyte); } let averageMemoryUsagePercent = null; if (averageMemoryUsagePercentValues.length !== 0) { - averageMemoryUsagePercent = averageOfValues(averageMemoryUsagePercentValues); + averageMemoryUsagePercent = scaleUpPercentage(averageOfValues(averageMemoryUsagePercentValues)); } return { @@ -186,14 +190,9 @@ function collectMetricValues(rows: MetricsExplorerRow[]) { function unpackMetrics(row: MetricsExplorerRow): Omit { return { - cpuCount: row[metricByField['system.cpu.cores']] as number | null, - averageCpuUsagePercent: row[metricByField['system.cpu.total.norm.pct']] as number | null, - totalMemoryMegabytes: row[metricByField['system.memory.total']] as number | null, - averageMemoryUsagePercent: row[metricByField['system.memory.used.pct']] as number | null, + cpuCount: unpackMetric(row, 'system.cpu.cores'), + averageCpuUsagePercent: unpackMetric(row, 'system.cpu.total.norm.pct'), + totalMemoryMegabytes: unpackMetric(row, 'system.memory.total'), + averageMemoryUsagePercent: unpackMetric(row, 'system.memory.used.pct'), }; } - -function averageOfValues(values: number[]) { - const sum = values.reduce((acc, value) => acc + value, 0); - return sum / values.length; -} diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx index 3a39b5bccbb10..bc3b7199ecd5d 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx @@ -112,7 +112,7 @@ function createFetchMock(): NodeMetricsTableFetchMock { function createPod( id: string, name: string, - uptimeMs: number, + startTime: number, cpuUsagePct: number, memoryUsageBytes: number ): Partial { @@ -121,8 +121,8 @@ function createPod( keys: [id, name], rows: [ { - [metricByField['kubernetes.pod.start_time']]: uptimeMs, - [metricByField['kubernetes.pod.cpu.usage.node.pct']]: cpuUsagePct, + [metricByField['kubernetes.pod.start_time']]: startTime, + [metricByField['kubernetes.pod.cpu.usage.limit.pct']]: cpuUsagePct, [metricByField['kubernetes.pod.memory.usage.bytes']]: memoryUsageBytes, } as MetricsExplorerSeries['rows'][number], ], diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx index 78edf32e1786b..9e8016ac1c2ef 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx @@ -17,9 +17,10 @@ import { EuiLoadingSpinner, EuiSpacer, } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; import React, { useMemo } from 'react'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; import type { SortState } from '../shared'; +import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; import type { PodNodeMetricsRow } from './use_pod_metrics_table'; export interface PodMetricsTableProps { @@ -76,7 +77,9 @@ export const PodMetricsTable = (props: PodMetricsTableProps) => { return ( <> { > { return [ { - name: 'Name', + name: i18n.translate('xpack.infra.metricsTable.pod.nameColumnHeader', { + defaultMessage: 'Name', + }), field: 'name', truncateText: true, textOnly: true, @@ -115,13 +122,17 @@ function podNodeColumns( }, }, { - name: 'Uptime', + name: i18n.translate('xpack.infra.metricsTable.pod.uptimeColumnHeader', { + defaultMessage: 'Uptime', + }), field: 'uptime', align: 'right', render: (uptime: number) => , }, { - name: 'CPU usage (avg.)', + name: i18n.translate('xpack.infra.metricsTable.pod.averageCpuUsagePercentColumnHeader', { + defaultMessage: 'CPU usage (avg.)', + }), field: 'averageCpuUsagePercent', align: 'right', render: (averageCpuUsagePercent: number) => ( @@ -129,7 +140,9 @@ function podNodeColumns( ), }, { - name: 'Memory usage (avg.)', + name: i18n.translate('xpack.infra.metricsTable.pod.averageMemoryUsageMegabytesColumnHeader', { + defaultMessage: 'Memory usage (avg.)', + }), field: 'averageMemoryUsageMegabytes', align: 'right', render: (averageMemoryUsageMegabytes: number) => ( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts index 116293a09a61c..cf097c52bc629 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts @@ -12,14 +12,17 @@ import type { } from '../../../../common/http_api/metrics_explorer'; import type { MetricsQueryOptions, SortState, UseNodeMetricsTableOptions } from '../shared'; import { + averageOfValues, + createMetricByFieldLookup, + makeUnpackMetric, metricsToApiOptions, + scaleUpPercentage, useInfrastructureNodeMetrics, - createMetricByFieldLookup, } from '../shared'; type PodMetricsField = | 'kubernetes.pod.start_time' - | 'kubernetes.pod.cpu.usage.node.pct' + | 'kubernetes.pod.cpu.usage.limit.pct' | 'kubernetes.pod.memory.usage.bytes'; const podMetricsQueryConfig: MetricsQueryOptions = { @@ -34,9 +37,9 @@ const podMetricsQueryConfig: MetricsQueryOptions = { aggregation: 'max', field: 'kubernetes.pod.start_time', }, - 'kubernetes.pod.cpu.usage.node.pct': { + 'kubernetes.pod.cpu.usage.limit.pct': { aggregation: 'avg', - field: 'kubernetes.pod.cpu.usage.node.pct', + field: 'kubernetes.pod.cpu.usage.limit.pct', }, 'kubernetes.pod.memory.usage.bytes': { aggregation: 'avg', @@ -46,6 +49,7 @@ const podMetricsQueryConfig: MetricsQueryOptions = { }; export const metricByField = createMetricByFieldLookup(podMetricsQueryConfig.metricsMap); +const unpackMetric = makeUnpackMetric(metricByField); export interface PodNodeMetricsRow { id: string; @@ -115,17 +119,18 @@ function rowWithoutMetrics(id: string, name: string) { } function calculateMetricAverages(rows: MetricsExplorerRow[]) { - const { uptimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues } = + const { startTimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues } = collectMetricValues(rows); let uptime = null; - if (uptimeValues.length !== 0) { - uptime = averageOfValues(uptimeValues); + if (startTimeValues.length !== 0) { + const startTime = startTimeValues.at(-1); + uptime = Date.now() - startTime!; } let averageCpuUsagePercent = null; if (averageCpuUsagePercentValues.length !== 0) { - averageCpuUsagePercent = averageOfValues(averageCpuUsagePercentValues); + averageCpuUsagePercent = scaleUpPercentage(averageOfValues(averageCpuUsagePercentValues)); } let averageMemoryUsageMegabytes = null; @@ -143,15 +148,15 @@ function calculateMetricAverages(rows: MetricsExplorerRow[]) { } function collectMetricValues(rows: MetricsExplorerRow[]) { - const uptimeValues: number[] = []; + const startTimeValues: number[] = []; const averageCpuUsagePercentValues: number[] = []; const averageMemoryUsageMegabytesValues: number[] = []; rows.forEach((row) => { - const { uptime, averageCpuUsagePercent, averageMemoryUsageMegabytes } = unpackMetrics(row); + const { startTime, averageCpuUsagePercent, averageMemoryUsageMegabytes } = unpackMetrics(row); - if (uptime !== null) { - uptimeValues.push(uptime); + if (startTime !== null) { + startTimeValues.push(startTime); } if (averageCpuUsagePercent !== null) { @@ -164,25 +169,18 @@ function collectMetricValues(rows: MetricsExplorerRow[]) { }); return { - uptimeValues, + startTimeValues, averageCpuUsagePercentValues, averageMemoryUsageMegabytesValues, }; } -function unpackMetrics(row: MetricsExplorerRow): Omit { +function unpackMetrics( + row: MetricsExplorerRow +): Omit & { startTime: number | null } { return { - uptime: row[metricByField['kubernetes.pod.start_time']] as number | null, - averageCpuUsagePercent: row[metricByField['kubernetes.pod.cpu.usage.node.pct']] as - | number - | null, - averageMemoryUsageMegabytes: row[metricByField['kubernetes.pod.memory.usage.bytes']] as - | number - | null, + startTime: unpackMetric(row, 'kubernetes.pod.start_time'), + averageCpuUsagePercent: unpackMetric(row, 'kubernetes.pod.cpu.usage.limit.pct'), + averageMemoryUsageMegabytes: unpackMetric(row, 'kubernetes.pod.memory.usage.bytes'), }; } - -function averageOfValues(values: number[]) { - const sum = values.reduce((acc, value) => acc + value, 0); - return sum / values.length; -} diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/number_cell.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/number_cell.tsx index 368484b4af43d..77898a08268a0 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/number_cell.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/number_cell.tsx @@ -7,6 +7,7 @@ import { EuiI18nNumber, EuiTextColor } from '@elastic/eui'; import React from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; interface NumberCellProps { value?: number; @@ -15,7 +16,15 @@ interface NumberCellProps { export function NumberCell({ value, unit }: NumberCellProps) { if (value === null || value === undefined || isNaN(value)) { - return N/A; + return ( + + + + ); } if (!unit) { diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/uptime_cell.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/uptime_cell.tsx index 80b2ba4a755e1..38962bae0c84c 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/uptime_cell.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/uptime_cell.tsx @@ -6,6 +6,8 @@ */ import { EuiTextColor } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; import React from 'react'; interface UptimeCellProps { @@ -14,7 +16,15 @@ interface UptimeCellProps { export function UptimeCell({ uptimeMs }: UptimeCellProps) { if (uptimeMs === null || uptimeMs === undefined || isNaN(uptimeMs)) { - return N/A; + return ( + + + + ); } return {formatUptime(uptimeMs)}; @@ -29,10 +39,18 @@ function formatUptime(uptimeMs: number): string { const minutes = Math.floor(uptimeMs / MS_PER_MINUTE); if (minutes > 0) { - return `${minutes}m`; + i18n.translate('xpack.infra.metricsTable.uptimeCell.minutesLabel', { + defaultMessage: '{minutes}m', + values: { + minutes, + }, + description: 'm is short for minutes', + }); } - return '< a minute'; + return i18n.translate('xpack.infra.metricsTable.uptimeCell.lessThanOneMinuteLabel', { + defaultMessage: '< a minute', + }); } if (uptimeMs < MS_PER_DAY) { @@ -41,10 +59,23 @@ function formatUptime(uptimeMs: number): string { const minutes = Math.floor(remainingUptimeMs / MS_PER_MINUTE); if (minutes > 0) { - return `${hours}h ${minutes}m`; + return i18n.translate('xpack.infra.metricsTable.uptimeCell.hoursAndMinutesLabel', { + defaultMessage: '{hours}h {minutes}m', + values: { + hours, + minutes, + }, + description: 'h is short for hours, m for minutes', + }); } - return `${hours}h`; + return i18n.translate('xpack.infra.metricsTable.uptimeCell.hoursLabel', { + defaultMessage: '{hours}h', + values: { + hours, + }, + description: 'h is short for hours', + }); } const days = Math.floor(uptimeMs / MS_PER_DAY); @@ -52,8 +83,21 @@ function formatUptime(uptimeMs: number): string { const hours = Math.floor(remainingUptimeMs / MS_PER_HOUR); if (hours > 0) { - return `${days}d ${hours}h`; + return i18n.translate('xpack.infra.metricsTable.uptimeCell.daysAndHoursLabel', { + defaultMessage: '{days}d {hours}h', + values: { + days, + hours, + }, + description: 'd is short for days, h for hours', + }); } - return `${days}d`; + return i18n.translate('xpack.infra.metricsTable.uptimeCell.daysLabel', { + defaultMessage: '{days}d', + values: { + days, + }, + description: 'd is short for days', + }); } diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/helpers.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/helpers.ts new file mode 100644 index 0000000000000..4c475300658b7 --- /dev/null +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/helpers.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { MetricsExplorerRow } from '../../../../../common/http_api/metrics_explorer'; + +export function averageOfValues(values: number[]) { + const sum = values.reduce((acc, value) => acc + value, 0); + return sum / values.length; +} + +export function makeUnpackMetric(metricByField: Record) { + // Make sure metrics are accessed as row[metricByField['FIELD_NAME']] + // Not row['FIELD_NAME'] by accident + return (row: MetricsExplorerRow, field: T) => row[metricByField[field]] as number | null; +} + +export function scaleUpPercentage(unscaled: number) { + // Scale e.g. 0.027 to 2.7 + return unscaled * 100; +} diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/index.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/index.ts index 06599df168690..a60aae2952a65 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/index.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/index.ts @@ -5,7 +5,8 @@ * 2.0. */ -export { metricsToApiOptions, createMetricByFieldLookup } from './metrics_to_api_options'; +export { averageOfValues, makeUnpackMetric, scaleUpPercentage } from './helpers'; +export { createMetricByFieldLookup, metricsToApiOptions } from './metrics_to_api_options'; export type { MetricsMap, MetricsQueryOptions } from './metrics_to_api_options'; export { useInfrastructureNodeMetrics } from './use_infrastructure_node_metrics'; export type { SortState } from './use_infrastructure_node_metrics'; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts index 25f78647fa026..12bc83c008e8f 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts @@ -7,11 +7,14 @@ export { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from './components'; export { + averageOfValues, + createMetricByFieldLookup, + makeUnpackMetric, metricsToApiOptions, + scaleUpPercentage, useInfrastructureNodeMetrics, - createMetricByFieldLookup, } from './hooks'; -export type { MetricsMap, SortState, MetricsQueryOptions } from './hooks'; +export type { MetricsMap, MetricsQueryOptions, SortState } from './hooks'; export type { IntegratedNodeMetricsTableProps, SourceProviderProps, diff --git a/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx b/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx index 2cdc7c803b93d..ee97c488b2443 100644 --- a/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx +++ b/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx @@ -10,7 +10,7 @@ import { CoreStart } from '@kbn/core/public'; import React from 'react'; import ReactDOM from 'react-dom'; import { Subscription } from 'rxjs'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { Embeddable, EmbeddableInput, IContainer } from '@kbn/embeddable-plugin/public'; import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; import { CoreProviders } from '../../apps/common_providers'; diff --git a/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx b/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx index 4128c2b17f624..5e1b73b018881 100644 --- a/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx +++ b/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx @@ -9,7 +9,8 @@ import { useCallback, useEffect } from 'react'; import useUpdateEffect from 'react-use/lib/useUpdateEffect'; import useMount from 'react-use/lib/useMount'; -import { TimeRange, TimefilterContract } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { TimefilterContract } from '@kbn/data-plugin/public'; import { useKibanaContextForPlugin } from './use_kibana'; export const useKibanaTimefilterTime = ({ diff --git a/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx b/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx index eb130a2e38c5d..0368b659fd6d8 100644 --- a/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx +++ b/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx @@ -10,7 +10,7 @@ import useInterval from 'react-use/lib/useInterval'; import datemath from '@kbn/datemath'; import moment from 'moment'; import * as rt from 'io-ts'; -import { TimeRange as KibanaTimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange as KibanaTimeRange } from '@kbn/es-query'; import { TimeRange } from '../../../../common/time/time_range'; import { useUrlState } from '../../../utils/use_url_state'; import { diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts index 108e4d908d801..e29510d344b40 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts @@ -16,15 +16,18 @@ export type PipelinesCreateTestBed = TestBed & { actions: ReturnType; }; -const testBedConfig: AsyncTestBedConfig = { - memoryRouter: { - initialEntries: [getCreatePath()], - componentRoutePath: ROUTES.create, - }, - doMountAsync: true, -}; +export const setup = async ( + httpSetup: HttpSetup, + queryParams: string = '' +): Promise => { + const testBedConfig: AsyncTestBedConfig = { + memoryRouter: { + initialEntries: [`${getCreatePath()}${queryParams}`], + componentRoutePath: ROUTES.create, + }, + doMountAsync: true, + }; -export const setup = async (httpSetup: HttpSetup): Promise => { const initTestBed = registerTestBed( WithAppDependencies(PipelinesCreate, httpSetup), testBedConfig diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx index ebc7acee3095e..f67d9d24ed690 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx @@ -80,6 +80,18 @@ describe('', () => { expect(find('apiRequestFlyout.apiRequestFlyoutTitle').text()).toBe('Request'); }); + test('should allow to prepopulate the name field', async () => { + await act(async () => { + testBed = await setup(httpSetup, '?name=test-pipeline'); + }); + + testBed.component.update(); + + expect(testBed.exists('nameField.input')).toBe(true); + expect(testBed.find('nameField.input').props().disabled).toBe(true); + expect(testBed.find('nameField.input').props().value).toBe('test-pipeline'); + }); + describe('form validation', () => { test('should prevent form submission if required fields are missing', async () => { const { form, actions, component, find } = testBed; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx index 36e7a78c87d92..ebb177f504c70 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx @@ -27,6 +27,8 @@ export interface PipelineFormProps { saveError: any; defaultValue?: Pipeline; isEditing?: boolean; + // That fields is used to disable the name field when creating a pipeline with the name prepopulated + canEditName?: boolean; } const defaultFormValue: Pipeline = Object.freeze({ @@ -43,6 +45,7 @@ export const PipelineForm: React.FunctionComponent = ({ saveError, isEditing, onCancel, + canEditName, }) => { const [isRequestVisible, setIsRequestVisible] = useState(false); @@ -129,6 +132,7 @@ export const PipelineForm: React.FunctionComponent = ({ onProcessorsUpdate={onProcessorsChangeHandler} hasVersion={Boolean(defaultValue.version)} isEditing={isEditing} + canEditName={canEditName} /> {/* Form submission */} diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx index 7beb057cef30e..aac3fa2914467 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx @@ -28,6 +28,7 @@ interface Props { hasVersion: boolean; onEditorFlyoutOpen: () => void; isEditing?: boolean; + canEditName?: boolean; } const UseField = getUseField({ component: Field }); @@ -41,6 +42,7 @@ export const PipelineFormFields: React.FunctionComponent = ({ isEditing, hasVersion, onEditorFlyoutOpen, + canEditName, }) => { const [isVersionVisible, setIsVersionVisible] = useState(hasVersion); @@ -74,7 +76,7 @@ export const PipelineFormFields: React.FunctionComponent = ({ path="name" componentProps={{ ['data-test-subj']: 'nameField', - euiFieldProps: { disabled: Boolean(isEditing) }, + euiFieldProps: { disabled: canEditName === false || Boolean(isEditing) }, }} /> diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx new file mode 100644 index 0000000000000..58a981e34f131 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { useRedirectPath as useRedirectToPathOrRedirectPath } from './redirect_path'; diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx new file mode 100644 index 0000000000000..a387661fc1b53 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx @@ -0,0 +1,56 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { renderHook } from '@testing-library/react-hooks'; +import { createMemoryHistory } from 'history'; +import { useRedirectPath } from './redirect_path'; +import { useKibana } from '../../shared_imports'; + +const mockedUseKibana = useKibana as jest.MockedFunction; +jest.mock('../../shared_imports'); + +describe('useRedirectPath', () => { + const mockedNavigateToUrl = jest.fn(); + beforeEach(() => { + mockedNavigateToUrl.mockReset(); + mockedUseKibana.mockReturnValue({ + services: { + application: { + navigateToUrl: mockedNavigateToUrl, + }, + }, + } as any); + }); + it('should redirect to redirect path if a redirect path is specified in the url', () => { + const history = createMemoryHistory(); + history.push( + '/app/management/ingest/ingest_pipelines/create?name=logs-system.syslog@custom&redirect_path=/test-redirect-path' + ); + + const { + result: { current: redirectToPathOrRedirectPath }, + } = renderHook(() => useRedirectPath(history)); + + redirectToPathOrRedirectPath('/test'); + + expect(mockedNavigateToUrl).toBeCalledWith('/test-redirect-path'); + }); + + it('should redirect to the provided path if no redirect path is specified in the url', () => { + const history = createMemoryHistory(); + history.push('/app/management/ingest/ingest_pipelines/create'); + + const { + result: { current: redirectToPathOrRedirectPath }, + } = renderHook(() => useRedirectPath(history)); + + redirectToPathOrRedirectPath('/test'); + + expect(mockedNavigateToUrl).not.toBeCalled(); + expect(history.location.pathname).toBe('/test'); + }); +}); diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx new file mode 100644 index 0000000000000..e70e094081da3 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { History } from 'history'; +import { useCallback, useMemo } from 'react'; + +import { useKibana } from '../../shared_imports'; + +/** + * This hook allow to redirect to the provided path or using redirect_path if it's provided in the query params. + */ +export function useRedirectPath(history: History) { + const { services } = useKibana(); + + const redirectPath = useMemo(() => { + const locationSearchParams = new URLSearchParams(history.location.search); + + return locationSearchParams.get('redirect_path'); + }, [history.location.search]); + + return useCallback( + (path: string) => { + if (redirectPath) { + services.application.navigateToUrl(redirectPath); + } else { + history.push(path); + } + }, + [redirectPath, services.application, history] + ); +} diff --git a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx index a7fbf6afaebf8..763751b2fabc9 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx @@ -14,6 +14,7 @@ import { getListPath } from '../../services/navigation'; import { Pipeline } from '../../../../common/types'; import { useKibana } from '../../../shared_imports'; import { PipelineForm } from '../../components'; +import { useRedirectToPathOrRedirectPath } from '../../hooks'; interface Props { /** @@ -26,15 +27,48 @@ interface LocationState { sourcePipeline?: Pipeline; } +function useFormDefaultValue(sourcePipeline?: Pipeline) { + const history = useHistory(); + + const locationSearchParams = useMemo(() => { + return new URLSearchParams(history.location.search); + }, [history.location.search]); + + const formDefaultValue = useMemo(() => { + if (sourcePipeline) { + return sourcePipeline; + } + + if (history.location.state?.sourcePipeline) { + return history.location.state.sourcePipeline; + } + + if (locationSearchParams.has('name')) { + return { + name: locationSearchParams.get('name') as string, + description: '', + processors: [], + on_failure: [], + }; + } + }, [sourcePipeline, history, locationSearchParams]); + + return { formDefaultValue, canEditName: !locationSearchParams.has('name') }; +} + export const PipelinesCreate: React.FunctionComponent = ({ sourcePipeline, }) => { const history = useHistory(); + const { services } = useKibana(); const [isSaving, setIsSaving] = useState(false); const [saveError, setSaveError] = useState(null); + const { formDefaultValue, canEditName } = useFormDefaultValue(sourcePipeline); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); + const onSave = async (pipeline: Pipeline) => { setIsSaving(true); setSaveError(null); @@ -48,27 +82,15 @@ export const PipelinesCreate: React.FunctionComponent { - history.push(getListPath()); - }; + const onCancel = () => redirectToPathOrRedirectPath(getListPath()); useEffect(() => { services.breadcrumbs.setBreadcrumbs('create'); }, [services]); - const formDefaultValue = useMemo(() => { - if (sourcePipeline) { - return sourcePipeline; - } - - if (history.location.state?.sourcePipeline) { - return history.location.state.sourcePipeline; - } - }, [sourcePipeline, history]); - return ( <> (false); const [saveError, setSaveError] = useState(null); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); const decodedPipelineName = attemptToURIDecode(name)!; @@ -60,11 +62,11 @@ export const PipelinesEdit: React.FunctionComponent { - history.push(getListPath()); + redirectToPathOrRedirectPath(getListPath()); }; useEffect(() => { diff --git a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx index 4e53cabd9dcbb..5f084a7cc65f7 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx @@ -30,6 +30,7 @@ import { PipelineTable } from './table'; import { PipelineDetailsFlyout } from './details_flyout'; import { PipelineNotFoundFlyout } from './not_found_flyout'; import { PipelineDeleteModal } from './delete_modal'; +import { useRedirectToPathOrRedirectPath } from '../../hooks'; const getPipelineNameFromLocation = (location: Location) => { const { pipeline } = parse(location.search.substring(1)); @@ -49,6 +50,7 @@ export const PipelinesList: React.FunctionComponent = ({ const [pipelinesToDelete, setPipelinesToDelete] = useState([]); const { data, isLoading, error, resendRequest } = services.api.useLoadPipelines(); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); // Track component loaded useEffect(() => { @@ -74,7 +76,7 @@ export const PipelinesList: React.FunctionComponent = ({ const goHome = () => { setShowFlyout(false); - history.push(getListPath()); + redirectToPathOrRedirectPath(getListPath()); }; if (error) { diff --git a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx index 08b6354abf201..38e2bb89da854 100644 --- a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx +++ b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx @@ -55,6 +55,7 @@ const renderWithRouter = ( startDate: '2022-03-08T18:52:15.532Z', endDate: '2022-06-09T17:52:15.532Z', }} + renderSessionsView={jest.fn()} /> ); diff --git a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx index f2949dd0e4ab1..7fe4b2ea3976a 100644 --- a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx +++ b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx @@ -12,7 +12,6 @@ import { EuiFlexGroup, EuiFlexItem, EuiIconTip, - EuiLoadingContent, EuiSpacer, EuiText, EuiTextColor, @@ -31,11 +30,13 @@ import { PercentWidget } from '../percent_widget'; import { KubernetesSecurityDeps } from '../../types'; import { AggregateResult } from '../../../common/types/aggregate'; import { useStyles } from './styles'; +import { TreeViewContainer } from '../tree_view_container'; const KubernetesSecurityRoutesComponent = ({ filter, indexPattern, globalFilter, + renderSessionsView, }: KubernetesSecurityDeps) => { const styles = useStyles(); @@ -203,10 +204,7 @@ const KubernetesSecurityRoutesComponent = ({ /> -
- - -
+ ); diff --git a/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts b/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts index 5e90d7c946f92..57f1427710999 100644 --- a/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts +++ b/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts @@ -17,8 +17,8 @@ export const useStyles = () => { const container: CSSObject = { padding: size.base, - border: euiTheme.border.thin, - borderRadius: euiTheme.border.radius.medium, + border: border.thin, + borderRadius: border.radius.medium, overflow: 'auto', position: 'relative', }; diff --git a/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx new file mode 100644 index 0000000000000..e934fe4a31f2d --- /dev/null +++ b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiSplitPanel, EuiText } from '@elastic/eui'; +import { useStyles } from './styles'; +import type { IndexPattern, GlobalFilter } from '../../types'; + +export interface TreeViewContainerDeps { + globalFilter: GlobalFilter; + renderSessionsView: (sessionsFilterQuery: string | undefined) => JSX.Element; + indexPattern?: IndexPattern; +} + +export const TreeViewContainer = ({ globalFilter, renderSessionsView }: TreeViewContainerDeps) => { + const styles = useStyles(); + // TODO: combine filterQuery with filters from tree view nav + + return ( + + + +

Tree view nav panel

+ + + + {renderSessionsView(globalFilter.filterQuery)} + + + ); +}; diff --git a/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts new file mode 100644 index 0000000000000..c490e5b711889 --- /dev/null +++ b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useMemo } from 'react'; +import { CSSObject } from '@emotion/react'; +import { useEuiTheme } from '../../hooks'; + +export const useStyles = () => { + const { euiTheme } = useEuiTheme(); + + const cached = useMemo(() => { + const { border } = euiTheme; + + const outerPanel: CSSObject = { + minHeight: '500px', + }; + + const navPanel: CSSObject = { + borderRight: border.thin, + }; + + const treeViewNav: CSSObject = { + width: '284px', + }; + + const sessionsPanel: CSSObject = { + overflowX: 'auto', + }; + + return { + outerPanel, + navPanel, + treeViewNav, + sessionsPanel, + }; + }, [euiTheme]); + + return cached; +}; diff --git a/x-pack/plugins/kubernetes_security/public/types.ts b/x-pack/plugins/kubernetes_security/public/types.ts index d6313b25bf011..bf25e00eec2b2 100644 --- a/x-pack/plugins/kubernetes_security/public/types.ts +++ b/x-pack/plugins/kubernetes_security/public/types.ts @@ -32,6 +32,7 @@ export interface GlobalFilter { export interface KubernetesSecurityDeps { filter: React.ReactNode; + renderSessionsView: (sessionsFilterQuery: string | undefined) => JSX.Element; indexPattern?: IndexPattern; globalFilter: GlobalFilter; } diff --git a/x-pack/plugins/lens/common/expressions/index.ts b/x-pack/plugins/lens/common/expressions/index.ts index 924141da6074a..ccb6343334d62 100644 --- a/x-pack/plugins/lens/common/expressions/index.ts +++ b/x-pack/plugins/lens/common/expressions/index.ts @@ -8,6 +8,6 @@ export * from './counter_rate'; export * from './collapse'; export * from './format_column'; -export * from './rename_columns'; +export * from './map_to_columns'; export * from './time_scale'; export * from './datatable'; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts new file mode 100644 index 0000000000000..8ce71d06f6579 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { mapToColumns } from './map_to_columns'; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts new file mode 100644 index 0000000000000..e5d678b88e5a5 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts @@ -0,0 +1,282 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mapToColumns } from './map_to_columns'; +import { Datatable } from '@kbn/expressions-plugin/common'; +import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; + +describe('map_to_columns', () => { + it('should rename columns of a given datatable', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'B', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + a: [ + { + id: 'b', + label: 'Austrailia', + }, + ], + b: [ + { + id: 'c', + label: 'Boomerang', + }, + ], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "b", + "meta": Object { + "type": "number", + }, + "name": "Austrailia", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Boomerang", + }, + ], + "rows": Array [ + Object { + "b": 1, + "c": 2, + }, + Object { + "b": 3, + "c": 4, + }, + Object { + "b": 5, + "c": 6, + }, + Object { + "b": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should keep columns which are not mapped', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'B', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + b: [{ id: 'c', label: 'Catamaran' }], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "a", + "meta": Object { + "type": "number", + }, + "name": "A", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Catamaran", + }, + ], + "rows": Array [ + Object { + "a": 1, + "c": 2, + }, + Object { + "a": 3, + "c": 4, + }, + Object { + "a": 5, + "c": 6, + }, + Object { + "a": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should map to multiple original columns', async () => { + const input: Datatable = { + type: 'datatable', + columns: [{ id: 'b', name: 'B', meta: { type: 'number' } }], + rows: [{ b: 2 }, { b: 4 }, { b: 6 }, { b: 8 }], + }; + + const idMap = { + b: [ + { id: 'c', label: 'Catamaran' }, + { id: 'd', label: 'Dinghy' }, + ], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Catamaran", + }, + Object { + "id": "d", + "meta": Object { + "type": "number", + }, + "name": "Dinghy", + }, + ], + "rows": Array [ + Object { + "c": 2, + "d": 2, + }, + Object { + "c": 4, + "d": 4, + }, + Object { + "c": 6, + "d": 6, + }, + Object { + "c": 8, + "d": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should rename date histograms', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'banana per 30 seconds', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + b: [{ id: 'c', label: 'Apple', operationType: 'date_histogram', sourceField: 'banana' }], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "a", + "meta": Object { + "type": "number", + }, + "name": "A", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Apple per 30 seconds", + }, + ], + "rows": Array [ + Object { + "a": 1, + "c": 2, + }, + Object { + "a": 3, + "c": 4, + }, + Object { + "a": 5, + "c": 6, + }, + Object { + "a": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); +}); diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts new file mode 100644 index 0000000000000..3315cd4170dd9 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts @@ -0,0 +1,32 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import type { MapToColumnsExpressionFunction } from './types'; + +export const mapToColumns: MapToColumnsExpressionFunction = { + name: 'lens_map_to_columns', + type: 'datatable', + help: i18n.translate('xpack.lens.functions.mapToColumns.help', { + defaultMessage: 'A helper to transform a datatable to match Lens column definitions', + }), + args: { + idMap: { + types: ['string'], + help: i18n.translate('xpack.lens.functions.mapToColumns.idMap.help', { + defaultMessage: + 'A JSON encoded object in which keys are the datatable column ids and values are the Lens column definitions. Any datatable columns not mentioned within the ID map will be kept unmapped.', + }), + }, + }, + inputTypes: ['datatable'], + async fn(...args) { + /** Build optimization: prevent adding extra code into initial bundle **/ + const { mapToOriginalColumns } = await import('./map_to_columns_fn'); + return mapToOriginalColumns(...args); + }, +}; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts new file mode 100644 index 0000000000000..401051db71065 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts @@ -0,0 +1,63 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { DatatableColumn } from '@kbn/expressions-plugin/common'; +import type { OriginalColumn, MapToColumnsExpressionFunction } from './types'; + +function getColumnName(originalColumn: OriginalColumn, newColumn: DatatableColumn) { + if (originalColumn?.operationType === 'date_histogram') { + const fieldName = originalColumn.sourceField; + + // HACK: This is a hack, and introduces some fragility into + // column naming. Eventually, this should be calculated and + // built more systematically. + return newColumn.name.replace(fieldName, originalColumn.label); + } + + return originalColumn.label; +} + +export const mapToOriginalColumns: MapToColumnsExpressionFunction['fn'] = ( + data, + { idMap: encodedIdMap } +) => { + const idMap = JSON.parse(encodedIdMap) as Record; + + return { + ...data, + rows: data.rows.map((row) => { + const mappedRow: Record = {}; + + Object.entries(row).forEach(([id, value]) => { + if (id in idMap) { + idMap[id].forEach(({ id: originalId }) => { + mappedRow[originalId] = value; + }); + } else { + mappedRow[id] = value; + } + }); + + return mappedRow; + }), + columns: data.columns + .map((column) => { + const originalColumns = idMap[column.id]; + + if (!originalColumns) { + return column; + } + + return originalColumns.map((originalColumn) => ({ + ...column, + id: originalColumn.id, + name: getColumnName(originalColumn, column), + })); + }) + .flat(), + }; +}; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts new file mode 100644 index 0000000000000..0c99260b704b1 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts @@ -0,0 +1,22 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; + +export type OriginalColumn = { id: string; label: string } & ( + | { operationType: 'date_histogram'; sourceField: string } + | { operationType: string; sourceField: never } +); + +export type MapToColumnsExpressionFunction = ExpressionFunctionDefinition< + 'lens_map_to_columns', + Datatable, + { + idMap: string; + }, + Datatable | Promise +>; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/index.ts b/x-pack/plugins/lens/common/expressions/rename_columns/index.ts deleted file mode 100644 index 86ab16e06ec01..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/index.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -export { renameColumns } from './rename_columns'; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts deleted file mode 100644 index 2047e4647cb4c..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts +++ /dev/null @@ -1,217 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { renameColumns } from './rename_columns'; -import { Datatable } from '@kbn/expressions-plugin/common'; -import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; - -describe('rename_columns', () => { - it('should rename columns of a given datatable', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'B', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - a: { - id: 'b', - label: 'Austrailia', - }, - b: { - id: 'c', - label: 'Boomerang', - }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "b", - "meta": Object { - "type": "number", - }, - "name": "Austrailia", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Boomerang", - }, - ], - "rows": Array [ - Object { - "b": 1, - "c": 2, - }, - Object { - "b": 3, - "c": 4, - }, - Object { - "b": 5, - "c": 6, - }, - Object { - "b": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); - - it('should keep columns which are not mapped', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'B', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - b: { id: 'c', label: 'Catamaran' }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "a", - "meta": Object { - "type": "number", - }, - "name": "A", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Catamaran", - }, - ], - "rows": Array [ - Object { - "a": 1, - "c": 2, - }, - Object { - "a": 3, - "c": 4, - }, - Object { - "a": 5, - "c": 6, - }, - Object { - "a": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); - - it('should rename date histograms', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'banana per 30 seconds', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - b: { id: 'c', label: 'Apple', operationType: 'date_histogram', sourceField: 'banana' }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "a", - "meta": Object { - "type": "number", - }, - "name": "A", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Apple per 30 seconds", - }, - ], - "rows": Array [ - Object { - "a": 1, - "c": 2, - }, - Object { - "a": 3, - "c": 4, - }, - Object { - "a": 5, - "c": 6, - }, - Object { - "a": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); -}); diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts deleted file mode 100644 index d425d5c80d18d..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { i18n } from '@kbn/i18n'; -import type { RenameColumnsExpressionFunction } from './types'; - -export const renameColumns: RenameColumnsExpressionFunction = { - name: 'lens_rename_columns', - type: 'datatable', - help: i18n.translate('xpack.lens.functions.renameColumns.help', { - defaultMessage: 'A helper to rename the columns of a datatable', - }), - args: { - idMap: { - types: ['string'], - help: i18n.translate('xpack.lens.functions.renameColumns.idMap.help', { - defaultMessage: - 'A JSON encoded object in which keys are the old column ids and values are the corresponding new ones. All other columns ids are kept.', - }), - }, - }, - inputTypes: ['datatable'], - async fn(...args) { - /** Build optimization: prevent adding extra code into initial bundle **/ - const { renameColumnFn } = await import('./rename_columns_fn'); - return renameColumnFn(...args); - }, -}; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts deleted file mode 100644 index 3cf4293ffa9f2..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { DatatableColumn } from '@kbn/expressions-plugin/common'; -import type { OriginalColumn, RenameColumnsExpressionFunction } from './types'; - -function getColumnName(originalColumn: OriginalColumn, newColumn: DatatableColumn) { - if (originalColumn?.operationType === 'date_histogram') { - const fieldName = originalColumn.sourceField; - - // HACK: This is a hack, and introduces some fragility into - // column naming. Eventually, this should be calculated and - // built more systematically. - return newColumn.name.replace(fieldName, originalColumn.label); - } - - return originalColumn.label; -} - -export const renameColumnFn: RenameColumnsExpressionFunction['fn'] = ( - data, - { idMap: encodedIdMap } -) => { - const idMap = JSON.parse(encodedIdMap) as Record; - - return { - ...data, - rows: data.rows.map((row) => { - const mappedRow: Record = {}; - Object.entries(idMap).forEach(([fromId, toId]) => { - mappedRow[toId.id] = row[fromId]; - }); - - Object.entries(row).forEach(([id, value]) => { - if (id in idMap) { - mappedRow[idMap[id].id] = value; - } else { - mappedRow[id] = value; - } - }); - - return mappedRow; - }), - columns: data.columns.map((column) => { - const mappedItem = idMap[column.id]; - - if (!mappedItem) { - return column; - } - - return { - ...column, - id: mappedItem.id, - name: getColumnName(mappedItem, column), - }; - }), - }; -}; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/types.ts b/x-pack/plugins/lens/common/expressions/rename_columns/types.ts deleted file mode 100644 index 6edfda41cc62f..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/types.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; - -export type OriginalColumn = { id: string; label: string } & ( - | { operationType: 'date_histogram'; sourceField: string } - | { operationType: string; sourceField: never } -); - -export type RenameColumnsExpressionFunction = ExpressionFunctionDefinition< - 'lens_rename_columns', - Datatable, - { - idMap: string; - }, - Datatable | Promise ->; diff --git a/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts b/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts index 46ec1f9cdc70c..0ca76ba61abbb 100644 --- a/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts +++ b/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts @@ -7,8 +7,9 @@ import moment from 'moment'; import type { Datatable } from '@kbn/expressions-plugin/common'; + +import type { TimeRange } from '@kbn/es-query'; import { createDatatableUtilitiesMock } from '@kbn/data-plugin/common/mocks'; -import type { TimeRange } from '@kbn/data-plugin/common'; import { functionWrapper } from '@kbn/expressions-plugin/common/expression_functions/specs/tests/utils'; // mock the specific inner variable: diff --git a/x-pack/plugins/lens/public/app_plugin/app.test.tsx b/x-pack/plugins/lens/public/app_plugin/app.test.tsx index fed226af7dde5..ba5811dfd6ba4 100644 --- a/x-pack/plugins/lens/public/app_plugin/app.test.tsx +++ b/x-pack/plugins/lens/public/app_plugin/app.test.tsx @@ -24,7 +24,8 @@ import { I18nProvider } from '@kbn/i18n-react'; import { SavedObjectSaveModal } from '@kbn/saved-objects-plugin/public'; import { checkForDuplicateTitle } from '../persistence'; import { createMemoryHistory } from 'history'; -import { FilterManager, Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { FilterManager } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { buildExistsFilter, FilterStateStore } from '@kbn/es-query'; import type { FieldSpec } from '@kbn/data-plugin/common'; @@ -409,7 +410,7 @@ describe('Lens App', () => { expect.objectContaining({ currentDataViewId: 'mockip', onChangeDataView: expect.any(Function), - onDataViewCreated: expect.any(Function), + onDataViewCreated: undefined, onAddField: undefined, }) ); @@ -417,7 +418,7 @@ describe('Lens App', () => { it('calls the nav component with the correct dataview picker props if permissions are given', async () => { const { instance, lensStore, services } = await mountWith({ preloadedState: {} }); - services.dataViewFieldEditor.userPermissions.editIndexPattern = () => true; + services.dataViewEditor.userPermissions.editDataView = () => true; const document = { savedObjectId: defaultSavedObjectId, state: { diff --git a/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx b/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx index b4657c4feaf55..82dd1884cb51e 100644 --- a/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx +++ b/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx @@ -244,7 +244,7 @@ export const LensTopNavMenu = ({ const [indexPatterns, setIndexPatterns] = useState([]); const [currentIndexPattern, setCurrentIndexPattern] = useState(); const [rejectedIndexPatterns, setRejectedIndexPatterns] = useState([]); - const editPermission = dataViewFieldEditor.userPermissions.editIndexPattern(); + const canEditDataView = Boolean(dataViewEditor?.userPermissions.editDataView()); const closeFieldEditor = useRef<() => void | undefined>(); const closeDataViewEditor = useRef<() => void | undefined>(); @@ -644,7 +644,7 @@ export const LensTopNavMenu = ({ const editField = useMemo( () => - editPermission + canEditDataView ? async (fieldName?: string, uiAction: 'edit' | 'add' = 'edit') => { if (currentIndexPattern?.id) { const indexPatternInstance = await data.dataViews.get(currentIndexPattern?.id); @@ -660,39 +660,54 @@ export const LensTopNavMenu = ({ } } : undefined, - [editPermission, currentIndexPattern?.id, data.dataViews, dataViewFieldEditor, refreshFieldList] + [ + canEditDataView, + currentIndexPattern?.id, + data.dataViews, + dataViewFieldEditor, + refreshFieldList, + ] ); const addField = useMemo( - () => (editPermission && editField ? () => editField(undefined, 'add') : undefined), - [editField, editPermission] + () => (canEditDataView && editField ? () => editField(undefined, 'add') : undefined), + [editField, canEditDataView] ); - const createNewDataView = useCallback(() => { - const dataViewEditPermission = dataViewEditor.userPermissions.editDataView; - if (!dataViewEditPermission) { - return; - } - closeDataViewEditor.current = dataViewEditor.openEditor({ - onSave: async (dataView) => { - if (dataView.id) { - handleIndexPatternChange({ - activeDatasources: Object.keys(datasourceStates).reduce( - (acc, datasourceId) => ({ - ...acc, - [datasourceId]: datasourceMap[datasourceId], - }), - {} - ), - datasourceStates, - indexPatternId: dataView.id, - setDatasourceState, - }); - refreshFieldList(); - } - }, - }); - }, [dataViewEditor, datasourceMap, datasourceStates, refreshFieldList, setDatasourceState]); + const createNewDataView = useMemo( + () => + canEditDataView + ? () => { + closeDataViewEditor.current = dataViewEditor.openEditor({ + onSave: async (dataView) => { + if (dataView.id) { + handleIndexPatternChange({ + activeDatasources: Object.keys(datasourceStates).reduce( + (acc, datasourceId) => ({ + ...acc, + [datasourceId]: datasourceMap[datasourceId], + }), + {} + ), + datasourceStates, + indexPatternId: dataView.id, + setDatasourceState, + }); + refreshFieldList(); + } + }, + }); + } + : undefined, + [ + dataViewEditor, + canEditDataView, + datasourceMap, + datasourceStates, + refreshFieldList, + setDatasourceState, + ] + ); const dataViewPickerProps = { trigger: { diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx index 6cb724b592bf1..a493447b2785b 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx @@ -16,8 +16,8 @@ import { } from './embeddable'; import { ReactExpressionRendererProps } from '@kbn/expressions-plugin/public'; import { spacesPluginMock } from '@kbn/spaces-plugin/public/mocks'; -import { Filter } from '@kbn/es-query'; -import { Query, TimeRange, FilterManager } from '@kbn/data-plugin/public'; +import { Filter, Query, TimeRange } from '@kbn/es-query'; +import { FilterManager } from '@kbn/data-plugin/public'; import type { DataViewsContract } from '@kbn/data-views-plugin/public'; import { Document } from '../persistence'; import { dataPluginMock } from '@kbn/data-plugin/public/mocks'; diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.tsx index 6befe841363c2..6c139917cca43 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.tsx @@ -9,14 +9,12 @@ import { isEqual, uniqBy } from 'lodash'; import React from 'react'; import { i18n } from '@kbn/i18n'; import { render, unmountComponentAtNode } from 'react-dom'; -import { DataViewBase, Filter } from '@kbn/es-query'; +import type { DataViewBase, Filter, Query, TimeRange } from '@kbn/es-query'; import type { PaletteOutput } from '@kbn/coloring'; import { DataPublicPluginStart, ExecutionContextSearch, - Query, TimefilterContract, - TimeRange, FilterManager, } from '@kbn/data-plugin/public'; import type { Start as InspectorStart } from '@kbn/inspector-plugin/public'; diff --git a/x-pack/plugins/lens/public/expressions.ts b/x-pack/plugins/lens/public/expressions.ts index 868d947464e5f..a5f193d63e4f3 100644 --- a/x-pack/plugins/lens/public/expressions.ts +++ b/x-pack/plugins/lens/public/expressions.ts @@ -8,7 +8,7 @@ import type { ExpressionsSetup } from '@kbn/expressions-plugin/public'; import { getDatatable } from '../common/expressions/datatable/datatable'; import { datatableColumn } from '../common/expressions/datatable/datatable_column'; -import { renameColumns } from '../common/expressions/rename_columns/rename_columns'; +import { mapToColumns } from '../common/expressions/map_to_columns/map_to_columns'; import { formatColumn } from '../common/expressions/format_column'; import { counterRate } from '../common/expressions/counter_rate'; import { getTimeScale } from '../common/expressions/time_scale/time_scale'; @@ -24,7 +24,7 @@ export const setupExpressions = ( collapse, counterRate, formatColumn, - renameColumns, + mapToColumns, datatableColumn, getDatatable(formatFactory), getTimeScale(getDatatableUtilities, getTimeZone), diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/filtering.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/filtering.tsx index d026df5fff4f2..d478267092606 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/filtering.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/filtering.tsx @@ -18,7 +18,7 @@ import { EuiPopoverProps, EuiIconTip, } from '@elastic/eui'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { GenericIndexPatternColumn, operationDefinitionMap } from '../operations'; import { validateQuery } from '../operations/definitions/filters'; import { QueryInput } from '../query_input'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx index ae94a09e41218..6900df51ccbba 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx @@ -10,7 +10,8 @@ import { EuiFormRow, EuiFlexItem, EuiFlexGroup } from '@elastic/eui'; import { EuiComboBox } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React, { useEffect, useRef, useState } from 'react'; -import { Query } from '@kbn/data-plugin/public'; + +import type { Query } from '@kbn/es-query'; import { DatatableUtilitiesService, parseTimeShift } from '@kbn/data-plugin/common'; import { adjustTimeScaleLabelSuffix, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx index e3d10c61c5caa..5e26e49a8ef17 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx @@ -39,8 +39,8 @@ import { i18n } from '@kbn/i18n'; import { FieldButton } from '@kbn/react-field'; import type { FieldFormatsStart } from '@kbn/field-formats-plugin/public'; import { EuiHighlight } from '@elastic/eui'; -import { Filter, buildEsQuery } from '@kbn/es-query'; -import { Query, KBN_FIELD_TYPES, ES_FIELD_TYPES, getEsQueryConfig } from '@kbn/data-plugin/public'; +import { Filter, buildEsQuery, Query } from '@kbn/es-query'; +import { KBN_FIELD_TYPES, ES_FIELD_TYPES, getEsQueryConfig } from '@kbn/data-plugin/public'; import { ChartsPluginSetup } from '@kbn/charts-plugin/public'; import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; import { DragDrop, DragDropIdentifier } from '../drag_drop'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/fields_accordion.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/fields_accordion.tsx index 509106f683984..33413bf0ba59b 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/fields_accordion.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/fields_accordion.tsx @@ -19,7 +19,7 @@ import { import classNames from 'classnames'; import { FieldFormatsStart } from '@kbn/field-formats-plugin/public'; import { Filter } from '@kbn/es-query'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { ChartsPluginSetup } from '@kbn/charts-plugin/public'; import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; import { IndexPatternField } from './types'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts index 6806b1ce47795..a37976f6d8069 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts @@ -33,6 +33,7 @@ import { FormulaIndexPatternColumn, RangeIndexPatternColumn, FiltersIndexPatternColumn, + PercentileIndexPatternColumn, } from './operations'; import { createMockedFullReference } from './operations/mocks'; import { cloneDeep } from 'lodash'; @@ -491,10 +492,10 @@ describe('IndexPattern Data Source', () => { Object { "arguments": Object { "idMap": Array [ - "{\\"col-0-0\\":{\\"label\\":\\"Count of records\\",\\"dataType\\":\\"number\\",\\"isBucketed\\":false,\\"sourceField\\":\\"___records___\\",\\"operationType\\":\\"count\\",\\"id\\":\\"col1\\"},\\"col-1-1\\":{\\"label\\":\\"Date\\",\\"dataType\\":\\"date\\",\\"isBucketed\\":true,\\"operationType\\":\\"date_histogram\\",\\"sourceField\\":\\"timestamp\\",\\"params\\":{\\"interval\\":\\"1d\\"},\\"id\\":\\"col2\\"}}", + "{\\"col-0-0\\":[{\\"label\\":\\"Count of records\\",\\"dataType\\":\\"number\\",\\"isBucketed\\":false,\\"sourceField\\":\\"___records___\\",\\"operationType\\":\\"count\\",\\"id\\":\\"col1\\"}],\\"col-1-1\\":[{\\"label\\":\\"Date\\",\\"dataType\\":\\"date\\",\\"isBucketed\\":true,\\"operationType\\":\\"date_histogram\\",\\"sourceField\\":\\"timestamp\\",\\"params\\":{\\"interval\\":\\"1d\\"},\\"id\\":\\"col2\\"}]}", ], }, - "function": "lens_rename_columns", + "function": "lens_map_to_columns", "type": "function", }, ], @@ -905,9 +906,9 @@ describe('IndexPattern Data Source', () => { const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; expect(ast.chain[1].arguments.metricsAtAllLevels).toEqual([false]); expect(JSON.parse(ast.chain[2].arguments.idMap[0] as string)).toEqual({ - 'col-0-0': expect.objectContaining({ id: 'bucket1' }), - 'col-1-1': expect.objectContaining({ id: 'bucket2' }), - 'col-2-2': expect.objectContaining({ id: 'metric' }), + 'col-0-0': [expect.objectContaining({ id: 'bucket1' })], + 'col-1-1': [expect.objectContaining({ id: 'bucket2' })], + 'col-2-2': [expect.objectContaining({ id: 'metric' })], }); }); @@ -948,6 +949,140 @@ describe('IndexPattern Data Source', () => { expect(ast.chain[1].arguments.timeFields).not.toContain('timefield'); }); + it('should call optimizeEsAggs once per operation for which it is available', () => { + const queryBaseState: DataViewBaseState = { + currentIndexPatternId: '1', + layers: { + first: { + indexPatternId: '1', + columns: { + col1: { + label: 'timestamp', + dataType: 'date', + operationType: 'date_histogram', + sourceField: 'timestamp', + isBucketed: true, + scale: 'interval', + params: { + interval: 'auto', + includeEmptyRows: true, + dropPartials: false, + }, + } as DateHistogramIndexPatternColumn, + col2: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + col3: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + }, + columnOrder: ['col1', 'col2', 'col3'], + incompleteColumns: {}, + }, + }, + }; + + const state = enrichBaseState(queryBaseState); + + const optimizeMock = jest.spyOn(operationDefinitionMap.percentile, 'optimizeEsAggs'); + + indexPatternDatasource.toExpression(state, 'first'); + + expect(operationDefinitionMap.percentile.optimizeEsAggs).toHaveBeenCalledTimes(1); + + optimizeMock.mockRestore(); + }); + + it('should update anticipated esAggs column IDs based on the order of the optimized agg expression builders', () => { + const queryBaseState: DataViewBaseState = { + currentIndexPatternId: '1', + layers: { + first: { + indexPatternId: '1', + columns: { + col1: { + label: 'timestamp', + dataType: 'date', + operationType: 'date_histogram', + sourceField: 'timestamp', + isBucketed: true, + scale: 'interval', + params: { + interval: 'auto', + includeEmptyRows: true, + dropPartials: false, + }, + } as DateHistogramIndexPatternColumn, + col2: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + col3: { + label: 'Count of records', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + timeScale: 'h', + }, + col4: { + label: 'Count of records2', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + timeScale: 'h', + }, + }, + columnOrder: ['col1', 'col2', 'col3', 'col4'], + incompleteColumns: {}, + }, + }, + }; + + const state = enrichBaseState(queryBaseState); + + const optimizeMock = jest + .spyOn(operationDefinitionMap.percentile, 'optimizeEsAggs') + .mockImplementation((aggs, esAggsIdMap) => { + // change the order of the aggregations + return { aggs: aggs.reverse(), esAggsIdMap }; + }); + + const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; + + expect(operationDefinitionMap.percentile.optimizeEsAggs).toHaveBeenCalledTimes(1); + + const idMap = JSON.parse(ast.chain[2].arguments.idMap as unknown as string); + + expect(Object.keys(idMap)).toEqual(['col-0-3', 'col-1-2', 'col-2-1', 'col-3-0']); + + optimizeMock.mockRestore(); + }); + describe('references', () => { beforeEach(() => { // @ts-expect-error we are inserting an invalid type @@ -1026,10 +1161,13 @@ describe('IndexPattern Data Source', () => { const state = enrichBaseState(queryBaseState); const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; + expect(JSON.parse(ast.chain[2].arguments.idMap[0] as string)).toEqual({ - 'col-0-0': expect.objectContaining({ - id: 'col1', - }), + 'col-0-0': [ + expect.objectContaining({ + id: 'col1', + }), + ], }); }); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts index 21ba19d5fb047..47222b51fc012 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { Operation } from '../../../types'; import type { TimeScaleUnit } from '../../../../common/expressions'; import type { OperationType } from '.'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filter_popover.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filter_popover.tsx index 46d69a550adfa..7166da0a3c0df 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filter_popover.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filter_popover.tsx @@ -9,7 +9,7 @@ import './filter_popover.scss'; import React from 'react'; import { EuiPopover, EuiSpacer } from '@elastic/eui'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { FilterValue, defaultLabel, isQueryValid } from '.'; import { IndexPattern } from '../../../types'; import { LabelInput } from '../shared_components'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx index 8b5f8e0c3dcc7..d3eea6e223401 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx @@ -11,7 +11,8 @@ import { fromKueryExpression, luceneStringToDsl, toElasticsearchQuery } from '@k import { omit } from 'lodash'; import { i18n } from '@kbn/i18n'; import { EuiFormRow, EuiLink, htmlIdGenerator } from '@elastic/eui'; -import type { AggFunctionsMapping, Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import type { AggFunctionsMapping } from '@kbn/data-plugin/public'; import { queryFilterToAst } from '@kbn/data-plugin/common'; import { buildExpressionFunction } from '@kbn/expressions-plugin/public'; import { updateColumnParam } from '../../layer_helpers'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/util.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/util.ts index 1af1537162885..ca6e5cd971349 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/util.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/util.ts @@ -13,7 +13,7 @@ import type { TinymathNamedArgument, TinymathVariable, } from '@kbn/tinymath'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { OperationDefinition, GenericIndexPatternColumn, @@ -498,7 +498,7 @@ Example: Calculate area based on side length help: i18n.translate('xpack.lens.formula.maxFunction.markdown', { defaultMessage: ` Finds the maximum value between two numbers. - + Example: Find the maximum between two fields averages \`pick_max(average(bytes), average(memory))\` `, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/validation.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/validation.ts index be034b7de46f4..5936b90c095ec 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/validation.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/validation.ts @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import { parse, TinymathLocation, TinymathVariable } from '@kbn/tinymath'; import type { TinymathAST, TinymathFunction, TinymathNamedArgument } from '@kbn/tinymath'; import { luceneStringToDsl, toElasticsearchQuery, fromKueryExpression } from '@kbn/es-query'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { parseTimeShift } from '@kbn/data-plugin/common'; import { findMathNodes, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts index 6ca79009ff95b..74d635cac02dc 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts @@ -12,7 +12,10 @@ import { CoreStart, } from '@kbn/core/public'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; -import { ExpressionAstFunction } from '@kbn/expressions-plugin/public'; +import { + ExpressionAstExpressionBuilder, + ExpressionAstFunction, +} from '@kbn/expressions-plugin/public'; import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; @@ -55,6 +58,7 @@ import { IndexPattern, IndexPatternField, IndexPatternLayer } from '../../types' import { DateRange, LayerType } from '../../../../common'; import { rangeOperation } from './ranges'; import { IndexPatternDimensionEditorProps, OperationSupportMatrix } from '../../dimension_panel'; +import type { OriginalColumn } from '../../to_expression'; export type { IncompleteColumn, @@ -378,6 +382,17 @@ interface BaseOperationDefinitionProps * Title for the help component */ helpComponentTitle?: string; + /** + * Optimizes EsAggs expression. Invoked only once per operation type. + */ + optimizeEsAggs?: ( + aggs: ExpressionAstExpressionBuilder[], + esAggsIdMap: Record, + aggExpressionToEsAggsIdMap: Map + ) => { + aggs: ExpressionAstExpressionBuilder[]; + esAggsIdMap: Record; + }; } interface BaseBuildColumnArgs { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx index ae8ba7d965ea7..08afcc447eec6 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx @@ -20,6 +20,12 @@ import { percentileOperation } from '.'; import { IndexPattern, IndexPatternLayer } from '../../types'; import { PercentileIndexPatternColumn } from './percentile'; import { TermsIndexPatternColumn } from './terms'; +import { + buildExpressionFunction, + buildExpression, + ExpressionAstExpressionBuilder, +} from '@kbn/expressions-plugin/public'; +import type { OriginalColumn } from '../../to_expression'; jest.mock('lodash', () => { const original = jest.requireActual('lodash'); @@ -187,6 +193,441 @@ describe('percentile', () => { }); }); + describe('optimizeEsAggs', () => { + const makeEsAggBuilder = (name: string, params: object) => + buildExpression({ + type: 'expression', + chain: [buildExpressionFunction(name, params).toAst()], + }); + + const buildMapsFromAggBuilders = (aggs: ExpressionAstExpressionBuilder[]) => { + const esAggsIdMap: Record = {}; + const aggsToIdsMap = new Map(); + aggs.forEach((builder, i) => { + const esAggsId = `col-${i}-${i}`; + esAggsIdMap[esAggsId] = [{ id: `original-${i}` } as OriginalColumn]; + aggsToIdsMap.set(builder, esAggsId); + }); + return { + esAggsIdMap, + aggsToIdsMap, + }; + }; + + it('should collapse percentile dimensions with matching parameters', () => { + const field1 = 'foo'; + const field2 = 'bar'; + const timeShift1 = '1d'; + const timeShift2 = '2d'; + + const aggs = [ + // group 1 + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: field1, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 2, + enabled: true, + schema: 'metric', + field: field1, + percentile: 20, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 3, + enabled: true, + schema: 'metric', + field: field1, + percentile: 30, + timeShift: undefined, + }), + // group 2 + makeEsAggBuilder('aggSinglePercentile', { + id: 4, + enabled: true, + schema: 'metric', + field: field2, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 5, + enabled: true, + schema: 'metric', + field: field2, + percentile: 40, + timeShift: undefined, + }), + // group 3 + makeEsAggBuilder('aggSinglePercentile', { + id: 6, + enabled: true, + schema: 'metric', + field: field2, + percentile: 50, + timeShift: timeShift1, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 7, + enabled: true, + schema: 'metric', + field: field2, + percentile: 60, + timeShift: timeShift1, + }), + // group 4 + makeEsAggBuilder('aggSinglePercentile', { + id: 8, + enabled: true, + schema: 'metric', + field: field2, + percentile: 70, + timeShift: timeShift2, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 9, + enabled: true, + schema: 'metric', + field: field2, + percentile: 80, + timeShift: timeShift2, + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs.length).toBe(4); + + expect(newAggs[0].functions[0].getArgument('field')![0]).toBe(field1); + expect(newAggs[0].functions[0].getArgument('timeShift')).toBeUndefined(); + expect(newAggs[1].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[1].functions[0].getArgument('timeShift')).toBeUndefined(); + expect(newAggs[2].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[2].functions[0].getArgument('timeShift')![0]).toBe(timeShift1); + expect(newAggs[3].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[3].functions[0].getArgument('timeShift')![0]).toBe(timeShift2); + + expect(newAggs).toMatchInlineSnapshot(` + Array [ + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "foo", + ], + "id": Array [ + 1, + ], + "percents": Array [ + 10, + 20, + 30, + ], + "schema": Array [ + "metric", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 4, + ], + "percents": Array [ + 10, + 40, + ], + "schema": Array [ + "metric", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 6, + ], + "percents": Array [ + 50, + 60, + ], + "schema": Array [ + "metric", + ], + "timeShift": Array [ + "1d", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 8, + ], + "percents": Array [ + 70, + 80, + ], + "schema": Array [ + "metric", + ], + "timeShift": Array [ + "2d", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + ] + `); + + expect(newIdMap).toMatchInlineSnapshot(` + Object { + "col-?-1.10": Array [ + Object { + "id": "original-0", + }, + ], + "col-?-1.20": Array [ + Object { + "id": "original-1", + }, + ], + "col-?-1.30": Array [ + Object { + "id": "original-2", + }, + ], + "col-?-4.10": Array [ + Object { + "id": "original-3", + }, + ], + "col-?-4.40": Array [ + Object { + "id": "original-4", + }, + ], + "col-?-6.50": Array [ + Object { + "id": "original-5", + }, + ], + "col-?-6.60": Array [ + Object { + "id": "original-6", + }, + ], + "col-?-8.70": Array [ + Object { + "id": "original-7", + }, + ], + "col-?-8.80": Array [ + Object { + "id": "original-8", + }, + ], + } + `); + }); + + it('should handle multiple identical percentiles', () => { + const field1 = 'foo'; + const field2 = 'bar'; + const samePercentile = 90; + + const aggs = [ + // group 1 + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 2, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 4, + enabled: true, + schema: 'metric', + field: field2, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 3, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs.length).toBe(2); + expect(newIdMap[`col-?-1.${samePercentile}`].length).toBe(3); + expect(newIdMap).toMatchInlineSnapshot(` + Object { + "col-2-2": Array [ + Object { + "id": "original-2", + }, + ], + "col-?-1.90": Array [ + Object { + "id": "original-0", + }, + Object { + "id": "original-1", + }, + Object { + "id": "original-3", + }, + ], + } + `); + }); + + it("shouldn't touch non-percentile aggs or single percentiles with no siblings", () => { + const aggs = [ + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: 'foo', + percentile: 30, + }), + makeEsAggBuilder('aggMax', { + id: 1, + enabled: true, + schema: 'metric', + field: 'bar', + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs).toEqual(aggs); + expect(newIdMap).toEqual(esAggsIdMap); + }); + }); + describe('buildColumn', () => { it('should set default percentile', () => { const indexPattern = createMockedIndexPattern(); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx index 0699ad5f88405..a313b03d34e1b 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx @@ -8,8 +8,13 @@ import { EuiFormRow, EuiRange, EuiRangeProps } from '@elastic/eui'; import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; -import { AggFunctionsMapping } from '@kbn/data-plugin/public'; -import { buildExpressionFunction } from '@kbn/expressions-plugin/public'; +import { AggFunctionsMapping, METRIC_TYPES } from '@kbn/data-plugin/public'; +import { + buildExpression, + buildExpressionFunction, + ExpressionAstExpressionBuilder, +} from '@kbn/expressions-plugin/public'; +import { AggExpressionFunctionArgs } from '@kbn/data-plugin/common'; import { OperationDefinition } from '.'; import { getFormatFromPreviousColumn, @@ -143,6 +148,120 @@ export const percentileOperation: OperationDefinition< } ).toAst(); }, + optimizeEsAggs: (_aggs, _esAggsIdMap, aggExpressionToEsAggsIdMap) => { + let aggs = [..._aggs]; + const esAggsIdMap = { ..._esAggsIdMap }; + + const percentileExpressionsByArgs: Record = {}; + + // group percentile dimensions by differentiating parameters + aggs.forEach((expressionBuilder) => { + const { + functions: [fnBuilder], + } = expressionBuilder; + if (fnBuilder.name === 'aggSinglePercentile') { + const groupByKey = `${fnBuilder.getArgument('field')?.[0]}-${ + fnBuilder.getArgument('timeShift')?.[0] + }`; + if (!(groupByKey in percentileExpressionsByArgs)) { + percentileExpressionsByArgs[groupByKey] = []; + } + + percentileExpressionsByArgs[groupByKey].push(expressionBuilder); + } + }); + + // collapse them into a single esAggs expression builder + Object.values(percentileExpressionsByArgs).forEach((expressionBuilders) => { + if (expressionBuilders.length <= 1) { + // don't need to optimize if there aren't more than one + return; + } + + // we're going to merge these percentile builders into a single builder, so + // remove them from the aggs array + aggs = aggs.filter((aggBuilder) => !expressionBuilders.includes(aggBuilder)); + + const { + functions: [firstFnBuilder], + } = expressionBuilders[0]; + + const esAggsColumnId = firstFnBuilder.getArgument('id')![0]; + const aggPercentilesConfig: AggExpressionFunctionArgs = { + id: esAggsColumnId, + enabled: firstFnBuilder.getArgument('enabled')?.[0], + schema: firstFnBuilder.getArgument('schema')?.[0], + field: firstFnBuilder.getArgument('field')?.[0], + percents: [], + // time shift is added to wrapping aggFilteredMetric if filter is set + timeShift: firstFnBuilder.getArgument('timeShift')?.[0], + }; + + const percentileToBuilder: Record = {}; + for (const builder of expressionBuilders) { + const percentile = builder.functions[0].getArgument('percentile')![0] as number; + if (percentile in percentileToBuilder) { + // found a duplicate percentile so let's optimize + + const duplicateExpressionBuilder = percentileToBuilder[percentile]; + + const idForDuplicate = aggExpressionToEsAggsIdMap.get(duplicateExpressionBuilder); + const idForThisOne = aggExpressionToEsAggsIdMap.get(builder); + + if (!idForDuplicate || !idForThisOne) { + throw new Error( + "Couldn't find esAggs ID for percentile expression builder... this should never happen." + ); + } + + esAggsIdMap[idForDuplicate].push(...esAggsIdMap[idForThisOne]); + + delete esAggsIdMap[idForThisOne]; + + // remove current builder + expressionBuilders = expressionBuilders.filter((b) => b !== builder); + } else { + percentileToBuilder[percentile] = builder; + aggPercentilesConfig.percents!.push(percentile); + } + } + + const multiPercentilesAst = buildExpressionFunction( + 'aggPercentiles', + aggPercentilesConfig + ).toAst(); + + aggs.push( + buildExpression({ + type: 'expression', + chain: [multiPercentilesAst], + }) + ); + + expressionBuilders.forEach((expressionBuilder) => { + const currentEsAggsId = aggExpressionToEsAggsIdMap.get(expressionBuilder); + if (currentEsAggsId === undefined) { + throw new Error('Could not find current column ID for percentile agg expression builder'); + } + // esAggs appends the percent number to the agg id to make distinct column IDs in the resulting datatable. + // We're anticipating that here by adding the `.`. + // The agg index will be assigned when we update all the indices in the ID map based on the agg order in the + // datasource's toExpression fn so we mark it as '?' for now. + const newEsAggsId = `col-?-${esAggsColumnId}.${ + expressionBuilder.functions[0].getArgument('percentile')![0] + }`; + + esAggsIdMap[newEsAggsId] = esAggsIdMap[currentEsAggsId]; + + delete esAggsIdMap[currentEsAggsId]; + }); + }); + + return { + esAggsIdMap, + aggs, + }; + }, getErrorMessage: (layer, columnId, indexPattern) => combineErrorMessages([ getInvalidFieldMessage(layer.columns[columnId] as FieldBasedIndexPatternColumn, indexPattern), diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts index 8e8b56d7d862d..8376a57ddc19d 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts @@ -7,7 +7,7 @@ import { partition, mapValues, pickBy, isArray } from 'lodash'; import { CoreStart } from '@kbn/core/public'; -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; import memoizeOne from 'memoize-one'; import type { VisualizeEditorLayersContext } from '@kbn/visualizations-plugin/public'; import type { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/query_input.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/query_input.tsx index 850f9d096d232..6d69760d51d87 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/query_input.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/query_input.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { isEqual } from 'lodash'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import { useDebouncedValue } from '../shared_components'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts index 0307e748ac1fb..6cfab965f36a9 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts @@ -6,7 +6,7 @@ */ import type { IUiSettingsClient } from '@kbn/core/public'; -import { partition } from 'lodash'; +import { partition, uniq } from 'lodash'; import { AggFunctionsMapping, EsaggsExpressionFunctionDefinition, @@ -27,7 +27,7 @@ import { DateHistogramIndexPatternColumn, RangeIndexPatternColumn } from './oper import { FormattedIndexPatternColumn } from './operations/definitions/column_types'; import { isColumnFormatted, isColumnOfType } from './operations/definitions/helpers'; -type OriginalColumn = { id: string } & GenericIndexPatternColumn; +export type OriginalColumn = { id: string } & GenericIndexPatternColumn; declare global { interface Window { @@ -38,6 +38,15 @@ declare global { } } +// esAggs column ID manipulation functions +const extractEsAggId = (id: string) => id.split('.')[0].split('-')[2]; +const updatePositionIndex = (currentId: string, newIndex: number) => { + const [fullId, percentile] = currentId.split('.'); + const idParts = fullId.split('-'); + idParts[1] = String(newIndex); + return idParts.join('-') + (percentile ? `.${percentile}` : ''); +}; + function getExpressionForLayer( layer: IndexPatternLayer, indexPattern: IndexPattern, @@ -95,7 +104,7 @@ function getExpressionForLayer( ); if (referenceEntries.length || esAggEntries.length) { - const aggs: ExpressionAstExpressionBuilder[] = []; + let aggs: ExpressionAstExpressionBuilder[] = []; const expressions: ExpressionAstFunction[] = []; sortedReferences(referenceEntries).forEach((colId) => { @@ -107,13 +116,17 @@ function getExpressionForLayer( }); const orderedColumnIds = esAggEntries.map(([colId]) => colId); + let esAggsIdMap: Record = {}; + const aggExpressionToEsAggsIdMap: Map = new Map(); esAggEntries.forEach(([colId, col], index) => { const def = operationDefinitionMap[col.operationType]; if (def.input !== 'fullReference' && def.input !== 'managedReference') { + const aggId = String(index); + const wrapInFilter = Boolean(def.filterable && col.filter); let aggAst = def.toEsAggsFn( col, - wrapInFilter ? `${index}-metric` : String(index), + wrapInFilter ? `${aggId}-metric` : aggId, indexPattern, layer, uiSettings, @@ -139,12 +152,25 @@ function getExpressionForLayer( } ).toAst(); } - aggs.push( - buildExpression({ - type: 'expression', - chain: [aggAst], - }) - ); + + const expressionBuilder = buildExpression({ + type: 'expression', + chain: [aggAst], + }); + aggs.push(expressionBuilder); + + const esAggsId = window.ELASTIC_LENS_DELAY_SECONDS + ? `col-${index + (col.isBucketed ? 0 : 1)}-${aggId}` + : `col-${index}-${aggId}`; + + esAggsIdMap[esAggsId] = [ + { + ...col, + id: colId, + }, + ]; + + aggExpressionToEsAggsIdMap.set(expressionBuilder, esAggsId); } }); @@ -164,19 +190,63 @@ function getExpressionForLayer( ); } - const idMap = esAggEntries.reduce((currentIdMap, [colId, column], index) => { - const esAggsId = window.ELASTIC_LENS_DELAY_SECONDS - ? `col-${index + (column.isBucketed ? 0 : 1)}-${index}` - : `col-${index}-${index}`; + uniq(esAggEntries.map(([_, column]) => column.operationType)).forEach((type) => { + const optimizeAggs = operationDefinitionMap[type].optimizeEsAggs?.bind( + operationDefinitionMap[type] + ); + if (optimizeAggs) { + const { aggs: newAggs, esAggsIdMap: newIdMap } = optimizeAggs( + aggs, + esAggsIdMap, + aggExpressionToEsAggsIdMap + ); + + aggs = newAggs; + esAggsIdMap = newIdMap; + } + }); + + /* + Update ID mappings with new agg array positions. + + Given this esAggs-ID-to-original-column map after percentile (for example) optimization: + col-0-0: column1 + col-?-1.34: column2 (34th percentile) + col-2-2: column3 + col-?-1.98: column4 (98th percentile) + + and this array of aggs + 0: { id: 0 } + 1: { id: 2 } + 2: { id: 1 } + + We need to update the anticipated agg indicies to match the aggs array: + col-0-0: column1 + col-2-1.34: column2 (34th percentile) + col-1-2: column3 + col-3-3.98: column4 (98th percentile) + */ + + const updatedEsAggsIdMap: Record = {}; + let counter = 0; + + const esAggsIds = Object.keys(esAggsIdMap); + aggs.forEach((builder) => { + const esAggId = builder.functions[0].getArgument('id')?.[0]; + const matchingEsAggColumnIds = esAggsIds.filter((id) => extractEsAggId(id) === esAggId); + + matchingEsAggColumnIds.forEach((currentId) => { + const currentColumn = esAggsIdMap[currentId][0]; + const aggIndex = window.ELASTIC_LENS_DELAY_SECONDS + ? counter + (currentColumn.isBucketed ? 0 : 1) + : counter; + const newId = updatePositionIndex(currentId, aggIndex); + updatedEsAggsIdMap[newId] = esAggsIdMap[currentId]; + + counter++; + }); + }); - return { - ...currentIdMap, - [esAggsId]: { - ...column, - id: colId, - }, - }; - }, {} as Record); const columnsWithFormatters = columnEntries.filter( ([, col]) => (isColumnOfType('range', col) && col.params?.parentFormat) || @@ -292,9 +362,9 @@ function getExpressionForLayer( }).toAst(), { type: 'function', - function: 'lens_rename_columns', + function: 'lens_map_to_columns', arguments: { - idMap: [JSON.stringify(idMap)], + idMap: [JSON.stringify(updatedEsAggsIdMap)], }, }, ...expressions, diff --git a/x-pack/plugins/lens/public/persistence/saved_object_store.ts b/x-pack/plugins/lens/public/persistence/saved_object_store.ts index fe0601c525016..ae2c55f66cc51 100644 --- a/x-pack/plugins/lens/public/persistence/saved_object_store.ts +++ b/x-pack/plugins/lens/public/persistence/saved_object_store.ts @@ -5,14 +5,13 @@ * 2.0. */ -import { Filter } from '@kbn/es-query'; +import { Filter, Query } from '@kbn/es-query'; import { SavedObjectAttributes, SavedObjectsClientContract, SavedObjectReference, ResolvedSimpleSavedObject, } from '@kbn/core/public'; -import { Query } from '@kbn/data-plugin/public'; import { DOC_TYPE } from '../../common'; import { LensSavedObjectAttributes } from '../async_services'; diff --git a/x-pack/plugins/lens/public/state_management/lens_slice.test.ts b/x-pack/plugins/lens/public/state_management/lens_slice.test.ts index 1896db481dbed..d38c0aed16676 100644 --- a/x-pack/plugins/lens/public/state_management/lens_slice.test.ts +++ b/x-pack/plugins/lens/public/state_management/lens_slice.test.ts @@ -6,7 +6,7 @@ */ import { EnhancedStore } from '@reduxjs/toolkit'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { switchDatasource, switchVisualization, diff --git a/x-pack/plugins/lens/public/state_management/types.ts b/x-pack/plugins/lens/public/state_management/types.ts index c11215d4a9f8e..4c6f4adc59ff5 100644 --- a/x-pack/plugins/lens/public/state_management/types.ts +++ b/x-pack/plugins/lens/public/state_management/types.ts @@ -7,8 +7,8 @@ import { VisualizeFieldContext } from '@kbn/ui-actions-plugin/public'; import { EmbeddableEditorState } from '@kbn/embeddable-plugin/public'; -import { Filter } from '@kbn/es-query'; -import { Query, SavedQuery } from '@kbn/data-plugin/public'; +import { Filter, Query } from '@kbn/es-query'; +import { SavedQuery } from '@kbn/data-plugin/public'; import { Document } from '../persistence'; import { TableInspectorAdapter } from '../editor_frame_service/types'; diff --git a/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx b/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx index 1ce9956bc148b..8ea28819ce59e 100644 --- a/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx +++ b/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx @@ -7,7 +7,8 @@ import React from 'react'; import { IEmbeddable, EmbeddableInput } from '@kbn/embeddable-plugin/public'; -import { Query, Filter, TimeRange, APPLY_FILTER_TRIGGER } from '@kbn/data-plugin/public'; +import type { Query, Filter, TimeRange } from '@kbn/es-query'; +import { APPLY_FILTER_TRIGGER } from '@kbn/data-plugin/public'; import { CollectConfigProps as CollectConfigPropsBase } from '@kbn/kibana-utils-plugin/public'; import { reactToUiComponent } from '@kbn/kibana-react-plugin/public'; import { diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts index 4c2f0785e7a3e..873159562dc8f 100644 --- a/x-pack/plugins/lens/public/types.ts +++ b/x-pack/plugins/lens/public/types.ts @@ -22,7 +22,7 @@ import type { Datatable, } from '@kbn/expressions-plugin/public'; import type { VisualizeEditorLayersContext } from '@kbn/visualizations-plugin/public'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { UiActionsStart, RowClickContext, diff --git a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx index c275d0da7697f..4f89ba1fdcedf 100644 --- a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx @@ -337,7 +337,7 @@ export const getXyVisualization = ({ }, updateLayersConfigurationFromContext({ prevState, layerId, context }) { - const { chartType, axisPosition, palette, metrics } = context; + const { chartType, axisPosition, palette, metrics, collapseFn } = context; const foundLayer = prevState?.layers.find((l) => l.layerId === layerId); if (!foundLayer || !isDataLayer(foundLayer)) { return prevState; @@ -356,6 +356,7 @@ export const getXyVisualization = ({ ...foundLayer, ...(chartType && { seriesType: chartType as SeriesType }), ...(palette && { palette }), + collapseFn, yConfig, layerType: isReferenceLine ? layerTypes.REFERENCELINE : layerTypes.DATA, } as XYLayerConfig; diff --git a/x-pack/plugins/lens/server/expressions/expressions.ts b/x-pack/plugins/lens/server/expressions/expressions.ts index bd516c756df15..1e80fc5bb49a3 100644 --- a/x-pack/plugins/lens/server/expressions/expressions.ts +++ b/x-pack/plugins/lens/server/expressions/expressions.ts @@ -10,7 +10,7 @@ import type { ExpressionsServerSetup } from '@kbn/expressions-plugin/server'; import { counterRate, formatColumn, - renameColumns, + mapToColumns, getTimeScale, getDatatable, } from '../../common/expressions'; @@ -25,7 +25,7 @@ export const setupExpressions = ( [ counterRate, formatColumn, - renameColumns, + mapToColumns, getDatatable(getFormatFactory(core)), getTimeScale(getDatatableUtilitiesFactory(core), getTimeZoneFactory(core)), ].forEach((expressionFn) => expressions.registerFunction(expressionFn)); diff --git a/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts index a560114d71b4f..fb87553113d88 100644 --- a/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts @@ -9,7 +9,7 @@ import type { Query } from '@kbn/data-plugin/common'; import type { Filter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { MapExtent } from './map_descriptor'; export type Timeslice = { diff --git a/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts index 1456fd2acd25b..36325c561b19a 100644 --- a/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts @@ -7,8 +7,7 @@ /* eslint-disable @typescript-eslint/consistent-type-definitions */ -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { Feature } from 'geojson'; import { EMSVectorTileStyleDescriptor, diff --git a/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts index 06dde68b8ff00..8ca9f2acb49d6 100644 --- a/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts @@ -8,8 +8,7 @@ /* eslint-disable @typescript-eslint/consistent-type-definitions */ import { FeatureCollection } from 'geojson'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { SortDirection } from '@kbn/data-plugin/common/search'; import { AGG_TYPE, diff --git a/x-pack/plugins/maps/common/mvt_request_body.ts b/x-pack/plugins/maps/common/mvt_request_body.ts index c2d367f89fa8a..2e7ade7f594ed 100644 --- a/x-pack/plugins/maps/common/mvt_request_body.ts +++ b/x-pack/plugins/maps/common/mvt_request_body.ts @@ -82,47 +82,11 @@ export function getHitsTileRequest({ exact_bounds: true, extent: 4096, // full resolution, query: requestBody.query, - fields: mergeFields( - [ - requestBody.docvalue_fields as Field[] | undefined, - requestBody.stored_fields as Field[] | undefined, - ], - [geometryFieldName] - ), + fields: requestBody.fields ? requestBody.fields : [], runtime_mappings: requestBody.runtime_mappings, + sort: requestBody.sort ? requestBody.sort : [], track_total_hits: typeof requestBody.size === 'number' ? requestBody.size + 1 : false, with_labels: hasLabels, }, }; } - -// can not use "import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey" -// SearchRequest is incorrectly typed and does not support Field as object -// https://github.com/elastic/elasticsearch-js/issues/1615 -type Field = - | string - | { - field: string; - format: string; - }; - -function mergeFields(fieldsList: Array, excludeNames: string[]): Field[] { - const fieldNames: string[] = []; - const mergedFields: Field[] = []; - - fieldsList.forEach((fields) => { - if (!fields) { - return; - } - - fields.forEach((field) => { - const fieldName = typeof field === 'string' ? field : field.field; - if (!excludeNames.includes(fieldName) && !fieldNames.includes(fieldName)) { - fieldNames.push(fieldName); - mergedFields.push(field); - } - }); - }); - - return mergedFields; -} diff --git a/x-pack/plugins/maps/public/actions/layer_actions.ts b/x-pack/plugins/maps/public/actions/layer_actions.ts index 6ffd9d59b1434..fee8754b48d7e 100644 --- a/x-pack/plugins/maps/public/actions/layer_actions.ts +++ b/x-pack/plugins/maps/public/actions/layer_actions.ts @@ -7,7 +7,7 @@ import { AnyAction, Dispatch } from 'redux'; import { ThunkDispatch } from 'redux-thunk'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { Adapters } from '@kbn/inspector-plugin/common/adapters'; import { MapStoreState } from '../reducers/store'; import { diff --git a/x-pack/plugins/maps/public/actions/map_actions.ts b/x-pack/plugins/maps/public/actions/map_actions.ts index c23b77326f293..8a14bc50dc975 100644 --- a/x-pack/plugins/maps/public/actions/map_actions.ts +++ b/x-pack/plugins/maps/public/actions/map_actions.ts @@ -12,7 +12,7 @@ import { ThunkDispatch } from 'redux-thunk'; import turfBboxPolygon from '@turf/bbox-polygon'; import turfBooleanContains from '@turf/boolean-contains'; import { Filter } from '@kbn/es-query'; -import { Query, TimeRange } from '@kbn/data-plugin/public'; +import type { Query, TimeRange } from '@kbn/es-query'; import { Geometry, Position } from 'geojson'; import { asyncForEach, asyncMap } from '@kbn/std'; import { DRAW_MODE, DRAW_SHAPE, LAYER_STYLE_TYPE } from '../../common/constants'; diff --git a/x-pack/plugins/maps/public/classes/joins/inner_join.ts b/x-pack/plugins/maps/public/classes/joins/inner_join.ts index 5276d5fcdae30..b8b96352625fc 100644 --- a/x-pack/plugins/maps/public/classes/joins/inner_join.ts +++ b/x-pack/plugins/maps/public/classes/joins/inner_join.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { Feature, GeoJsonProperties } from 'geojson'; import { ESTermSource } from '../sources/es_term_source'; import { getComputedFieldNamePrefix } from '../styles/vector/style_util'; diff --git a/x-pack/plugins/maps/public/classes/layers/layer.tsx b/x-pack/plugins/maps/public/classes/layers/layer.tsx index 369f3a0099d66..b01f2b9b8ca04 100644 --- a/x-pack/plugins/maps/public/classes/layers/layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/layer.tsx @@ -8,7 +8,7 @@ /* eslint-disable @typescript-eslint/consistent-type-definitions */ import type { Map as MbMap } from '@kbn/mapbox-gl'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import _ from 'lodash'; import React, { ReactElement } from 'react'; import { EuiIcon } from '@elastic/eui'; diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts b/x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts index 81e80c7cf739f..26b95a95e6660 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { LayerDescriptor } from '../../../../common/descriptor_types'; import { ES_GEO_FIELD_TYPE, SCALING_TYPES } from '../../../../common/constants'; import { ESSearchSource } from './es_search_source'; diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts index 24470ae0fade7..e374989e07892 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts @@ -116,7 +116,7 @@ describe('ESSearchSource', () => { }); const tileUrl = await esSearchSource.getTileUrl(searchFilters, '1234', false); expect(tileUrl).toBe( - `rootdir/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=foobar-title-*&hasLabels=false&requestBody=(foobar%3AES_DSL_PLACEHOLDER%2Cparams%3A('0'%3A('0'%3Aindex%2C'1'%3A(fields%3A()%2Ctitle%3A'foobar-title-*'))%2C'1'%3A('0'%3Asize%2C'1'%3A1000)%2C'2'%3A('0'%3Afilter%2C'1'%3A!())%2C'3'%3A('0'%3Aquery)%2C'4'%3A('0'%3Aindex%2C'1'%3A(fields%3A()%2Ctitle%3A'foobar-title-*'))%2C'5'%3A('0'%3Aquery%2C'1'%3A(language%3AKQL%2Cquery%3A'tooltipField%3A%20foobar'))%2C'6'%3A('0'%3AfieldsFromSource%2C'1'%3A!(tooltipField%2CstyleField))%2C'7'%3A('0'%3Asource%2C'1'%3A!(tooltipField%2CstyleField))))&token=1234` + `rootdir/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=foobar-title-*&hasLabels=false&requestBody=(foobar%3AES_DSL_PLACEHOLDER%2Cparams%3A('0'%3A('0'%3Aindex%2C'1'%3A(fields%3A()%2Ctitle%3A'foobar-title-*'))%2C'1'%3A('0'%3Asize%2C'1'%3A1000)%2C'2'%3A('0'%3Afilter%2C'1'%3A!())%2C'3'%3A('0'%3Aquery)%2C'4'%3A('0'%3Aindex%2C'1'%3A(fields%3A()%2Ctitle%3A'foobar-title-*'))%2C'5'%3A('0'%3Aquery%2C'1'%3A(language%3AKQL%2Cquery%3A'tooltipField%3A%20foobar'))%2C'6'%3A('0'%3AfieldsFromSource%2C'1'%3A!(_id))%2C'7'%3A('0'%3Asource%2C'1'%3A!f)%2C'8'%3A('0'%3Afields%2C'1'%3A!(tooltipField%2CstyleField))))&token=1234` ); }); }); diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx index 83118410bac41..078369ea3c32e 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx @@ -9,11 +9,11 @@ import _ from 'lodash'; import React, { ReactElement } from 'react'; import { i18n } from '@kbn/i18n'; import { GeoJsonProperties, Geometry, Position } from 'geojson'; -import { type Filter, buildPhraseFilter } from '@kbn/es-query'; +import { type Filter, buildPhraseFilter, type TimeRange } from '@kbn/es-query'; import type { DataViewField, DataView } from '@kbn/data-plugin/common'; import { lastValueFrom } from 'rxjs'; import { Adapters } from '@kbn/inspector-plugin/common/adapters'; -import { SortDirection, SortDirectionNumeric, TimeRange } from '@kbn/data-plugin/common'; +import { SortDirection, SortDirectionNumeric } from '@kbn/data-plugin/common'; import { AbstractESSource } from '../es_source'; import { getHttp, @@ -589,27 +589,39 @@ export class ESSearchSource extends AbstractESSource implements IMvtVectorSource return {}; } - const { docValueFields } = getDocValueAndSourceFields( - indexPattern, - this._getTooltipPropertyNames(), - 'strict_date_optional_time' - ); - - const initialSearchContext = { docvalue_fields: docValueFields }; // Request fields in docvalue_fields insted of _source const searchService = getSearchService(); - const searchSource = await searchService.searchSource.create(initialSearchContext as object); + const searchSource = await searchService.searchSource.create(); searchSource.setField('trackTotalHits', false); searchSource.setField('index', indexPattern); searchSource.setField('size', 1); - const query = { language: 'kuery', query: `_id:"${docId}" and _index:"${index}"`, }; - searchSource.setField('query', query); - searchSource.setField('fieldsFromSource', this._getTooltipPropertyNames()); + + // searchSource calls dataView.getComputedFields to seed docvalueFields + // dataView.getComputedFields adds each date field in the dataView to docvalueFields to ensure standardized date format across kibana + // we don't need these as they request unneeded fields and bloat responses + // setting fieldsFromSource notifies searchSource to filterout unused docvalueFields + // '_id' is used since the value of 'fieldsFromSource' is irreverent because '_source: false'. + searchSource.setField('fieldsFromSource', ['_id']); + searchSource.setField('source', false); + + // Get all tooltip properties from fields API + searchSource.setField( + 'fields', + this._getTooltipPropertyNames().map((fieldName) => { + const field = indexPattern.fields.getByName(fieldName); + return field && field.type === 'date' + ? { + field: fieldName, + format: 'strict_date_optional_time', + } + : fieldName; + }) + ); const { rawResponse: resp } = await lastValueFrom( searchSource.fetch$({ @@ -827,41 +839,50 @@ export class ESSearchSource extends AbstractESSource implements IMvtVectorSource const indexPattern = await this.getIndexPattern(); const indexSettings = await loadIndexSettings(indexPattern.title); - const fieldNames = searchFilters.fieldNames.filter( - (fieldName) => fieldName !== this._descriptor.geoField - ); - const { docValueFields, sourceOnlyFields } = getDocValueAndSourceFields( - indexPattern, - fieldNames, - 'epoch_millis' - ); - - const initialSearchContext = { docvalue_fields: docValueFields }; // Request fields in docvalue_fields insted of _source - - const searchSource = await this.makeSearchSource( - searchFilters, - indexSettings.maxResultWindow, - initialSearchContext - ); - searchSource.setField('fieldsFromSource', searchFilters.fieldNames); // Setting "fields" filters out unused scripted fields - if (sourceOnlyFields.length === 0) { - searchSource.setField('source', false); // do not need anything from _source - } else { - searchSource.setField('source', sourceOnlyFields); - } + const searchSource = await this.makeSearchSource(searchFilters, indexSettings.maxResultWindow); + // searchSource calls dataView.getComputedFields to seed docvalueFields + // dataView.getComputedFields adds each date field in the dataView to docvalueFields to ensure standardized date format across kibana + // we don't need these as they request unneeded fields and bloat responses + // setting fieldsFromSource notifies searchSource to filterout unused docvalueFields + // '_id' is used since the value of 'fieldsFromSource' is irreverent because '_source: false'. + searchSource.setField('fieldsFromSource', ['_id']); + searchSource.setField('source', false); if (this._hasSort()) { searchSource.setField('sort', this._buildEsSort()); } + // use fields API + searchSource.setField( + 'fields', + searchFilters.fieldNames + .filter((fieldName) => { + return fieldName !== this._descriptor.geoField; + }) + .map((fieldName) => { + const field = indexPattern.fields.getByName(fieldName); + return field && field.type === 'date' + ? { + field: fieldName, + format: 'epoch_millis', + } + : fieldName; + }) + ); + const mvtUrlServicePath = getHttp().basePath.prepend( `/${GIS_API_PATH}/${MVT_GETTILE_API_PATH}/{z}/{x}/{y}.pbf` ); + const requestBody = searchSource.getSearchRequestBody(); + // Remove keys not supported by elasticsearch vector tile search API + delete requestBody.script_fields; + delete requestBody.stored_fields; + return `${mvtUrlServicePath}\ ?geometryFieldName=${this._descriptor.geoField}\ &index=${indexPattern.title}\ &hasLabels=${hasLabels}\ -&requestBody=${encodeMvtResponseBody(searchSource.getSearchRequestBody())}\ +&requestBody=${encodeMvtResponseBody(requestBody)}\ &token=${refreshToken}`; } diff --git a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts index e524f546ecc68..1272438e11e39 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts @@ -14,7 +14,7 @@ import type { Query } from '@kbn/data-plugin/common'; import type { KibanaExecutionContext } from '@kbn/core/public'; import { RequestAdapter } from '@kbn/inspector-plugin/common/adapters/request'; import { lastValueFrom } from 'rxjs'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { AbstractVectorSource, BoundsRequestMeta } from '../vector_source'; import { getAutocompleteService, diff --git a/x-pack/plugins/maps/public/classes/sources/es_term_source/es_term_source.ts b/x-pack/plugins/maps/public/classes/sources/es_term_source/es_term_source.ts index 0f5f60ba28601..5447910dc524a 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_term_source/es_term_source.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_term_source/es_term_source.ts @@ -7,7 +7,8 @@ import _ from 'lodash'; import { i18n } from '@kbn/i18n'; -import { ISearchSource, Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; +import { ISearchSource } from '@kbn/data-plugin/public'; import { Adapters } from '@kbn/inspector-plugin/common/adapters'; import { AGG_TYPE, diff --git a/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx b/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx index 8c2323521fb28..64082a85df6b7 100644 --- a/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx +++ b/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx @@ -18,7 +18,7 @@ import { i18n } from '@kbn/i18n'; import type { Query } from '@kbn/data-plugin/common'; import type { MapGeoJSONFeature } from '@kbn/mapbox-gl'; import { Filter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { Adapters } from '@kbn/inspector-plugin/common/adapters'; import { ActionExecutionContext, Action } from '@kbn/ui-actions-plugin/public'; import { GEO_JSON_TYPE, VECTOR_SHAPE_TYPE } from '../../../../common/constants'; diff --git a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts index 51b19e7b05c96..09c9cd5f9482c 100644 --- a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts +++ b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts @@ -8,7 +8,7 @@ import { AnyAction } from 'redux'; import { ThunkDispatch } from 'redux-thunk'; import { connect } from 'react-redux'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { FilterEditor } from './filter_editor'; import { getEditState, getSelectedLayer } from '../../../selectors/map_selectors'; import { setLayerQuery, updateSourceProp } from '../../../actions'; diff --git a/x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx b/x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx index ee5a534f7c6f0..d2ed9d640b140 100644 --- a/x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx +++ b/x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx @@ -12,7 +12,7 @@ import { EuiRangeTick } from '@elastic/eui/src/components/form/range/range_ticks import { i18n } from '@kbn/i18n'; import { Observable, Subscription } from 'rxjs'; import { first } from 'rxjs/operators'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { epochToKbnDateFormat, getInterval, getTicks } from './time_utils'; import { getTimeFilter } from '../../kibana_services'; import { Timeslice } from '../../../common/descriptor_types'; diff --git a/x-pack/plugins/maps/public/embeddable/map_component.tsx b/x-pack/plugins/maps/public/embeddable/map_component.tsx index f9bc8423f44e0..4709255927734 100644 --- a/x-pack/plugins/maps/public/embeddable/map_component.tsx +++ b/x-pack/plugins/maps/public/embeddable/map_component.tsx @@ -9,7 +9,7 @@ import React, { Component, RefObject } from 'react'; import uuid from 'uuid/v4'; import { EuiLoadingChart } from '@elastic/eui'; import type { Filter } from '@kbn/es-query'; -import type { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import type { LayerDescriptor, MapCenterAndZoom } from '../../common/descriptor_types'; import type { MapEmbeddableType } from './types'; import type { LazyLoadedMapModules } from '../lazy_load_bundle'; diff --git a/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx b/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx index 97c8c190479fd..0b2d2e4f9bbc6 100644 --- a/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx +++ b/x-pack/plugins/maps/public/embeddable/map_embeddable.tsx @@ -14,7 +14,7 @@ import { render, unmountComponentAtNode } from 'react-dom'; import { Subscription } from 'rxjs'; import { Unsubscribe } from 'redux'; import { EuiEmptyPrompt } from '@elastic/eui'; -import { type Filter, compareFilters } from '@kbn/es-query'; +import { type Filter, compareFilters, type TimeRange, type Query } from '@kbn/es-query'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; import { Embeddable, @@ -25,7 +25,7 @@ import { omitGenericEmbeddableInput, } from '@kbn/embeddable-plugin/public'; import { ActionExecutionContext } from '@kbn/ui-actions-plugin/public'; -import { APPLY_FILTER_TRIGGER, TimeRange, Query } from '@kbn/data-plugin/public'; +import { APPLY_FILTER_TRIGGER } from '@kbn/data-plugin/public'; import { ACTION_GLOBAL_APPLY_FILTER } from '@kbn/unified-search-plugin/public'; import { createExtentFilter } from '../../common/elasticsearch_util'; import { diff --git a/x-pack/plugins/maps/public/embeddable/types.ts b/x-pack/plugins/maps/public/embeddable/types.ts index 3b51756dba260..bf1691efde2d6 100644 --- a/x-pack/plugins/maps/public/embeddable/types.ts +++ b/x-pack/plugins/maps/public/embeddable/types.ts @@ -13,7 +13,7 @@ import { EmbeddableOutput, SavedObjectEmbeddableInput, } from '@kbn/embeddable-plugin/public'; -import { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import { MapCenterAndZoom, MapExtent } from '../../common/descriptor_types'; import { MapSavedObjectAttributes } from '../../common/map_saved_object_type'; import { MapSettings } from '../reducers/map'; diff --git a/x-pack/plugins/maps/public/inspector/vector_tile_adapter/components/get_tile_request.test.ts b/x-pack/plugins/maps/public/inspector/vector_tile_adapter/components/get_tile_request.test.ts index 4534c8047409d..d43366031eea3 100644 --- a/x-pack/plugins/maps/public/inspector/vector_tile_adapter/components/get_tile_request.test.ts +++ b/x-pack/plugins/maps/public/inspector/vector_tile_adapter/components/get_tile_request.test.ts @@ -80,7 +80,7 @@ test('Should return elasticsearch vector tile request for hits tiles', () => { expect( getTileRequest({ layerId: '1', - tileUrl: `http://localhost:5601/pof/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=geo.coordinates&hasLabels=true&index=kibana_sample_data_logs&requestBody=(_source%3A!f%2Cdocvalue_fields%3A!()%2Cquery%3A(bool%3A(filter%3A!((range%3A(timestamp%3A(format%3Astrict_date_optional_time%2Cgte%3A%272022-04-22T16%3A46%3A00.744Z%27%2Clte%3A%272022-04-29T16%3A46%3A05.345Z%27))))%2Cmust%3A!()%2Cmust_not%3A!()%2Cshould%3A!()))%2Cruntime_mappings%3A(hour_of_day%3A(script%3A(source%3A%27emit(doc%5B!%27timestamp!%27%5D.value.getHour())%3B%27)%2Ctype%3Along))%2Cscript_fields%3A()%2Csize%3A10000%2Cstored_fields%3A!(geo.coordinates))&token=415049b6-bb0a-444a-a7b9-89717db5183c`, + tileUrl: `http://localhost:5601/zuv/api/maps/mvt/getTile/4/2/6.pbf?geometryFieldName=geo.coordinates&index=kibana_sample_data_logs&hasLabels=true&requestBody=(_source%3A!f%2Cfields%3A!((field%3A%27%40timestamp%27%2Cformat%3Aepoch_millis)%2Cbytes)%2Cquery%3A(bool%3A(filter%3A!((range%3A(timestamp%3A(format%3Astrict_date_optional_time%2Cgte%3A%272022-06-15T20%3A00%3A00.000Z%27%2Clte%3A%272022-06-16T20%3A48%3A02.517Z%27))))%2Cmust%3A!()%2Cmust_not%3A!()%2Cshould%3A!()))%2Cruntime_mappings%3A(hour_of_day%3A(script%3A(source%3A%27emit(doc%5B!%27timestamp!%27%5D.value.getHour())%3B%27)%2Ctype%3Along))%2Csize%3A10000%2Csort%3A!((%27%40timestamp%27%3A(order%3Adesc%2Cunmapped_type%3Aboolean))))&token=7afe7c2d-c96b-4bdb-9b5e-819aceac80a1`, x: 0, y: 0, z: 2, @@ -98,8 +98,8 @@ test('Should return elasticsearch vector tile request for hits tiles', () => { range: { timestamp: { format: 'strict_date_optional_time', - gte: '2022-04-22T16:46:00.744Z', - lte: '2022-04-29T16:46:05.345Z', + gte: '2022-06-15T20:00:00.000Z', + lte: '2022-06-16T20:48:02.517Z', }, }, }, @@ -109,7 +109,13 @@ test('Should return elasticsearch vector tile request for hits tiles', () => { should: [], }, }, - fields: [], + fields: [ + { + field: '@timestamp', + format: 'epoch_millis', + }, + 'bytes', + ], runtime_mappings: { hour_of_day: { script: { @@ -118,6 +124,14 @@ test('Should return elasticsearch vector tile request for hits tiles', () => { type: 'long', }, }, + sort: [ + { + '@timestamp': { + order: 'desc', + unmapped_type: 'boolean', + }, + }, + ], track_total_hits: 10001, with_labels: true, }, diff --git a/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts b/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts index acbbf25c8a49f..79bfc0ce0d8fd 100644 --- a/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts +++ b/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts @@ -7,7 +7,7 @@ import { i18n } from '@kbn/i18n'; import type { Filter } from '@kbn/es-query'; -import type { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import type { ExpressionValueSearchContext } from '@kbn/data-plugin/common/search/expressions/kibana_context_type'; import type { ExpressionFunctionDefinition, Render } from '@kbn/expressions-plugin/public'; import { REGION_MAP_RENDER, REGION_MAP_VIS_TYPE, RegionMapVisConfig } from './types'; diff --git a/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx b/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx index 8c51e5c38a197..2334b9af1996c 100644 --- a/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx +++ b/x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx @@ -7,7 +7,7 @@ import React from 'react'; import type { Filter } from '@kbn/es-query'; -import type { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import { RegionMapVisConfig } from './types'; import type { LazyLoadedMapModules } from '../../lazy_load_bundle'; import { MapComponent } from '../../embeddable/map_component'; diff --git a/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts b/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts index 8239a017bf0fa..116b3375eba76 100644 --- a/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts +++ b/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts @@ -7,7 +7,7 @@ import { i18n } from '@kbn/i18n'; import type { Filter } from '@kbn/es-query'; -import type { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import type { ExpressionValueSearchContext } from '@kbn/data-plugin/common/search/expressions/kibana_context_type'; import type { ExpressionFunctionDefinition, Render } from '@kbn/expressions-plugin/public'; import { TILE_MAP_RENDER, TILE_MAP_VIS_TYPE, TileMapVisConfig } from './types'; diff --git a/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx b/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx index abe5c571c1c39..fd5f916baf4c6 100644 --- a/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx +++ b/x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx @@ -7,7 +7,7 @@ import React from 'react'; import type { Filter } from '@kbn/es-query'; -import type { Query, TimeRange } from '@kbn/data-plugin/common'; +import type { Query, TimeRange } from '@kbn/es-query'; import { TileMapVisConfig } from './types'; import type { LazyLoadedMapModules } from '../../lazy_load_bundle'; import { MapComponent } from '../../embeddable/map_component'; diff --git a/x-pack/plugins/maps/public/locators.ts b/x-pack/plugins/maps/public/locators.ts index 7cfdb7a0d3fb1..b08c68ec96d61 100644 --- a/x-pack/plugins/maps/public/locators.ts +++ b/x-pack/plugins/maps/public/locators.ts @@ -9,13 +9,8 @@ import rison from 'rison-node'; import type { SerializableRecord } from '@kbn/utility-types'; -import { type Filter, isFilterPinned } from '@kbn/es-query'; -import type { - TimeRange, - Query, - GlobalQueryStateFromUrl, - RefreshInterval, -} from '@kbn/data-plugin/public'; +import { type Filter, isFilterPinned, type TimeRange, type Query } from '@kbn/es-query'; +import type { GlobalQueryStateFromUrl, RefreshInterval } from '@kbn/data-plugin/public'; import { setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public'; import type { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/public'; import type { LayerDescriptor } from '../common/descriptor_types'; diff --git a/x-pack/plugins/maps/public/reducers/map/types.ts b/x-pack/plugins/maps/public/reducers/map/types.ts index c2ed508992500..9495a52e888c3 100644 --- a/x-pack/plugins/maps/public/reducers/map/types.ts +++ b/x-pack/plugins/maps/public/reducers/map/types.ts @@ -9,7 +9,7 @@ import type { Query } from '@kbn/data-plugin/common'; import { Filter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { CustomIcon, DrawState, diff --git a/x-pack/plugins/maps/public/routes/map_page/map_app/index.ts b/x-pack/plugins/maps/public/routes/map_page/map_app/index.ts index f99d7cee0869f..af9054cd99570 100644 --- a/x-pack/plugins/maps/public/routes/map_page/map_app/index.ts +++ b/x-pack/plugins/maps/public/routes/map_page/map_app/index.ts @@ -9,7 +9,7 @@ import { connect } from 'react-redux'; import { ThunkDispatch } from 'redux-thunk'; import { AnyAction } from 'redux'; import { Filter } from '@kbn/es-query'; -import { Query, TimeRange } from '@kbn/data-plugin/public'; +import type { Query, TimeRange } from '@kbn/es-query'; import { MapApp } from './map_app'; import { getFlyoutDisplay, getIsFullScreen } from '../../../selectors/ui_selectors'; import { diff --git a/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx b/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx index 0f95c5530e466..e508cb37d45af 100644 --- a/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx +++ b/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx @@ -12,8 +12,8 @@ import { i18n } from '@kbn/i18n'; import { AppLeaveAction, AppMountParameters } from '@kbn/core/public'; import { Adapters } from '@kbn/embeddable-plugin/public'; import { Subscription } from 'rxjs'; -import { type Filter, FilterStateStore } from '@kbn/es-query'; -import type { Query, TimeRange, DataView } from '@kbn/data-plugin/common'; +import { type Filter, FilterStateStore, type Query, type TimeRange } from '@kbn/es-query'; +import type { DataView } from '@kbn/data-plugin/common'; import { SavedQuery, QueryStateChange, QueryState } from '@kbn/data-plugin/public'; import { getData, diff --git a/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts b/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts index 64a4b19675873..27ec99bbf2374 100644 --- a/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts +++ b/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts @@ -7,7 +7,7 @@ import type { Query } from '@kbn/data-plugin/common'; import { Filter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { MapCenter } from '../../../../common/descriptor_types'; import { MapSettings } from '../../../reducers/map'; diff --git a/x-pack/plugins/maps/public/routes/map_page/url_state/app_state_manager.ts b/x-pack/plugins/maps/public/routes/map_page/url_state/app_state_manager.ts index b9cd9ddc78a3c..ff4989fd56c77 100644 --- a/x-pack/plugins/maps/public/routes/map_page/url_state/app_state_manager.ts +++ b/x-pack/plugins/maps/public/routes/map_page/url_state/app_state_manager.ts @@ -7,7 +7,7 @@ import { Subject } from 'rxjs'; import { Filter } from '@kbn/es-query'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; export interface MapsAppState { query?: Query | null; diff --git a/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts b/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts index a2070e594424a..eb9510c6bed23 100644 --- a/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts +++ b/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts @@ -5,8 +5,8 @@ * 2.0. */ -import { Filter } from '@kbn/es-query'; -import { TimeRange, RefreshInterval } from '@kbn/data-plugin/public'; +import type { Filter, TimeRange } from '@kbn/es-query'; +import { RefreshInterval } from '@kbn/data-plugin/public'; import { syncQueryStateWithUrl } from '@kbn/data-plugin/public'; import { getData } from '../../../kibana_services'; import { kbnUrlStateStorage } from '../../../render_app'; diff --git a/x-pack/plugins/maps/public/selectors/map_selectors.ts b/x-pack/plugins/maps/public/selectors/map_selectors.ts index d1e4f2f021ff5..06897f469b48f 100644 --- a/x-pack/plugins/maps/public/selectors/map_selectors.ts +++ b/x-pack/plugins/maps/public/selectors/map_selectors.ts @@ -10,7 +10,7 @@ import { FeatureCollection } from 'geojson'; import _ from 'lodash'; import type { Query } from '@kbn/data-plugin/common'; import { Filter } from '@kbn/es-query'; -import { TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; import { RasterTileLayer } from '../classes/layers/raster_tile_layer/raster_tile_layer'; import { EmsVectorTileLayer } from '../classes/layers/ems_vector_tile_layer/ems_vector_tile_layer'; import { diff --git a/x-pack/plugins/ml/common/util/date_utils.ts b/x-pack/plugins/ml/common/util/date_utils.ts index d6605e5856d8b..b0ed853fe24db 100644 --- a/x-pack/plugins/ml/common/util/date_utils.ts +++ b/x-pack/plugins/ml/common/util/date_utils.ts @@ -9,7 +9,7 @@ import dateMath from '@kbn/datemath'; import { formatDate } from '@elastic/eui'; -import { TimeRange } from '@kbn/data-plugin/common'; +import type { TimeRange } from '@kbn/es-query'; import { TIME_FORMAT } from '../constants/time_format'; export function formatHumanReadableDate(ts: number) { diff --git a/x-pack/plugins/ml/public/application/components/full_time_range_selector/full_time_range_selector.test.tsx b/x-pack/plugins/ml/public/application/components/full_time_range_selector/full_time_range_selector.test.tsx index 5e4d87901c979..0d20267f33ecb 100644 --- a/x-pack/plugins/ml/public/application/components/full_time_range_selector/full_time_range_selector.test.tsx +++ b/x-pack/plugins/ml/public/application/components/full_time_range_selector/full_time_range_selector.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { shallowWithIntl } from '@kbn/test-jest-helpers'; import { FullTimeRangeSelector } from '.'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { DataView } from '@kbn/data-views-plugin/public'; // Create a mock for the setFullTimeRange function in the service. diff --git a/x-pack/plugins/ml/public/application/components/help_popover/help_popover.tsx b/x-pack/plugins/ml/public/application/components/help_popover/help_popover.tsx index 95c66d58dbb75..b7d12c492e86a 100644 --- a/x-pack/plugins/ml/public/application/components/help_popover/help_popover.tsx +++ b/x-pack/plugins/ml/public/application/components/help_popover/help_popover.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { ReactNode } from 'react'; +import React, { FC, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiButtonIcon, @@ -17,7 +17,7 @@ import { } from '@elastic/eui'; import './help_popover.scss'; -export const HelpPopoverButton = ({ onClick }: { onClick: EuiLinkButtonProps['onClick'] }) => { +export const HelpPopoverButton: FC<{ onClick: EuiLinkButtonProps['onClick'] }> = ({ onClick }) => { return ( { +} + +export const HelpPopover: FC = ({ anchorPosition, children, title }) => { + const [isPopoverOpen, setIsPopoverOpen] = useState(false); + return ( } className="mlHelpPopover" - closePopover={closePopover} - isOpen={isOpen} + closePopover={setIsPopoverOpen.bind(null, false)} + isOpen={isPopoverOpen} ownFocus panelClassName="mlHelpPopover__panel" panelPaddingSize="none" diff --git a/x-pack/plugins/ml/public/application/components/influencers_list/influencers_list.tsx b/x-pack/plugins/ml/public/application/components/influencers_list/influencers_list.tsx index 5f27113a341e2..456c8e8719dd3 100644 --- a/x-pack/plugins/ml/public/application/components/influencers_list/influencers_list.tsx +++ b/x-pack/plugins/ml/public/application/components/influencers_list/influencers_list.tsx @@ -131,11 +131,13 @@ const InfluencersByName: FC = ({ return ( - +

{influencerFieldName}

 {influencerValues} + + ); }; @@ -146,7 +148,7 @@ export const InfluencersList: FC = ({ influencers, influen - +

{ - const [isPopoverOpen, setIsPopoverOpen] = useState(false); +import { HelpPopover } from '../../../../../components/help_popover/help_popover'; +export const MulticlassConfusionMatrixHelpPopover: FC = () => { return ( { - setIsPopoverOpen(!isPopoverOpen); - }} - /> - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} title={i18n.translate('xpack.ml.dataframe.analytics.confusionMatrixPopoverTitle', { defaultMessage: 'Normalized confusion matrix', })} diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/roc_curve_help_popover.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/roc_curve_help_popover.tsx index a14096d77be9f..41c69befe9c1a 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/roc_curve_help_popover.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/roc_curve_help_popover.tsx @@ -5,29 +5,15 @@ * 2.0. */ -import React, { useState } from 'react'; +import React, { FC } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; -import { - HelpPopover, - HelpPopoverButton, -} from '../../../../../components/help_popover/help_popover'; - -export const RocCurveHelpPopover = () => { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); +import { HelpPopover } from '../../../../../components/help_popover/help_popover'; +export const RocCurveHelpPopover: FC = () => { return ( { - setIsPopoverOpen(!isPopoverOpen); - }} - /> - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} title={i18n.translate('xpack.ml.dataframe.analytics.rocCurvePopoverTitle', { defaultMessage: 'Receiver operating characteristic (ROC) curve', })} diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx index 141be7cb00ebf..c186903686015 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx @@ -13,7 +13,7 @@ import { debounce } from 'lodash'; import { fromKueryExpression, luceneStringToDsl, toElasticsearchQuery } from '@kbn/es-query'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { DataView } from '@kbn/data-views-plugin/common'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import { Dictionary } from '../../../../../../../common/types/common'; diff --git a/x-pack/plugins/ml/public/application/explorer/_explorer.scss b/x-pack/plugins/ml/public/application/explorer/_explorer.scss index 4d04a0747e3a9..5214624851945 100644 --- a/x-pack/plugins/ml/public/application/explorer/_explorer.scss +++ b/x-pack/plugins/ml/public/application/explorer/_explorer.scss @@ -1,31 +1,3 @@ -$borderRadius: $euiBorderRadius / 2; - -.ml-explorer { - .results-container { - - .no-influencers-warning { - float: left; - padding-top: $euiSizeXS; - padding-left: $euiSize; - color: $euiColorDarkShade; - font-size: $euiFontSizeS; - } - - .panel-title { - font-size: $euiFontSizeM; - font-weight: 400; - color: $euiColorDarkShade; - display: inline-block; - padding-bottom: $euiSizeXS; - } - - .panel-sub-title { - color: $euiColorDarkShade; - font-size: $euiFontSizeXS; - } - } -} - .mlSwimLaneContainer { /* Override legend styles */ .echLegendListContainer { diff --git a/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx b/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx index f2d739d2f5852..9f247fbce72c2 100644 --- a/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx +++ b/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx @@ -227,7 +227,7 @@ export const AnomaliesMap: FC = ({ anomalies, jobIds }) => { id="mlAnomalyExplorerAnomaliesMapAccordionId" initialIsOpen={true} buttonContent={ - +

= React.memo( - +

= React.memo( )} - + {viewBySwimlaneOptions.length > 0 && ( @@ -275,7 +275,7 @@ export const AnomalyTimeline: FC = React.memo( -
+ {viewByLoadedForTimeFormatted && ( = React.memo( defaultMessage="(Job score across all influencers)" /> )} -
+ { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); +import { HelpPopover } from '../components/help_popover/help_popover'; +export const AnomalyTimelineHelpPopover: FC = () => { return ( { - setIsPopoverOpen(!isPopoverOpen); - }} - /> - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} title={i18n.translate('xpack.ml.explorer.anomalyTimelinePopoverTitle', { defaultMessage: 'Anomaly timelines', })} diff --git a/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx b/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx index 7b66b38ca6bff..40d39fefc1b86 100644 --- a/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx +++ b/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx @@ -9,7 +9,7 @@ import React, { FC, useState, useEffect } from 'react'; import { EuiCode, EuiInputPopover } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { fromKueryExpression, luceneStringToDsl, toElasticsearchQuery } from '@kbn/es-query'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/common'; import { SEARCH_QUERY_LANGUAGE, ErrorMessage } from '../../../../../common/constants/search'; diff --git a/x-pack/plugins/ml/public/application/explorer/explorer.tsx b/x-pack/plugins/ml/public/application/explorer/explorer.tsx index 5352eea1ab505..690949cd40ed6 100644 --- a/x-pack/plugins/ml/public/application/explorer/explorer.tsx +++ b/x-pack/plugins/ml/public/application/explorer/explorer.tsx @@ -25,10 +25,13 @@ import { EuiBadge, EuiResizableContainer, useIsWithinBreakpoints, + useEuiTheme, } from '@elastic/eui'; +import { css } from '@emotion/react'; import useObservable from 'react-use/lib/useObservable'; import type { DataView } from '@kbn/data-views-plugin/common'; import type { TimefilterContract } from '@kbn/data-plugin/public'; +import { HelpPopover } from '../components/help_popover'; import { AnnotationFlyout } from '../components/annotations/annotation_flyout'; // @ts-ignore import { AnnotationsTable } from '../components/annotations/annotations_table'; @@ -348,7 +351,7 @@ export const Explorer: FC = ({ const { services: { charts: chartsService }, } = useMlKibana(); - + const { euiTheme } = useEuiTheme(); const mlLocator = useMlLocator(); const { @@ -462,10 +465,7 @@ export const Explorer: FC = ({ {annotationsError !== undefined && ( <> - +

= ({ +

= ({ } > <> + = ({ - +

= ({ {noInfluencersConfigured ? ( -
-
+ {mainPanelContent} ) : (
- + + = ({ ]} minSize={'200px'} initialSize={20} - paddingSize={'s'} + paddingSize={'none'} onToggleCollapsed={onToggleCollapsed} > -
- - -

- - + + + +

+ +

+ + + + +

- } - position="right" - /> -

- +

+ + + + + + {loading ? ( ) : ( @@ -682,7 +702,7 @@ export const Explorer: FC = ({ mode="main" minSize={'70%'} initialSize={80} - paddingSize={'s'} + paddingSize={'none'} > {mainPanelContent} diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/route_resolver.ts b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/route_resolver.ts index b305c69c47d87..a9819812601fa 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/route_resolver.ts +++ b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/route_resolver.ts @@ -6,7 +6,7 @@ */ import rison from 'rison-node'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { Filter } from '@kbn/es-query'; import type { LensSavedObjectAttributes } from '@kbn/lens-plugin/public'; import { canCreateAndStashADJob } from './create_job'; diff --git a/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts b/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts index 25b1b6b0f14a7..0ed3b511b669e 100644 --- a/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts +++ b/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts @@ -7,7 +7,8 @@ import { Observable, of } from 'rxjs'; import { map as mapObservable } from 'rxjs/operators'; -import type { TimefilterContract, TimeRange } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import type { TimefilterContract } from '@kbn/data-plugin/public'; import type { RecordForInfluencer } from './results_service/results_service'; import type { EntityField } from '../../../common/util/anomaly_utils'; import type { CombinedJob } from '../../../common/types/anomaly_detection_jobs'; diff --git a/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts b/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts index d91bd4b497391..cbe4017a02835 100644 --- a/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts +++ b/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts @@ -6,7 +6,8 @@ */ import { IUiSettingsClient } from '@kbn/core/public'; -import { TimefilterContract, TimeRange, UI_SETTINGS } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { TimefilterContract, UI_SETTINGS } from '@kbn/data-plugin/public'; import { getBoundsRoundedToInterval, TimeBuckets, diff --git a/x-pack/plugins/ml/public/application/timeseriesexplorer/_timeseriesexplorer.scss b/x-pack/plugins/ml/public/application/timeseriesexplorer/_timeseriesexplorer.scss index dc9178f7062f2..6160db3b940c8 100644 --- a/x-pack/plugins/ml/public/application/timeseriesexplorer/_timeseriesexplorer.scss +++ b/x-pack/plugins/ml/public/application/timeseriesexplorer/_timeseriesexplorer.scss @@ -2,19 +2,6 @@ .ml-time-series-explorer { color: $euiColorDarkShade; - .results-container { - .panel-title { - font-size: $euiFontSizeM; - font-weight: 400; - color: $euiColorDarkShade; - } - - .entity-count-text { - color: $euiColorSuccess; - font-size: $euiFontSizeS; - } - } - .forecast-controls { float: right; } diff --git a/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer.js b/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer.js index f6fa86c85cccb..b2644819e4522 100644 --- a/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer.js +++ b/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer.js @@ -31,6 +31,7 @@ import { EuiTitle, EuiAccordion, EuiBadge, + EuiTextColor, } from '@elastic/eui'; import { ResizeChecker } from '@kbn/kibana-utils-plugin/public'; import { TimeSeriesExplorerHelpPopover } from './timeseriesexplorer_help_popover'; @@ -1080,10 +1081,10 @@ export class TimeSeriesExplorer extends React.Component { (fullRefresh === false || loading === false) && hasResults === true && (
-
- - -

+ + + +

{i18n.translate( 'xpack.ml.timeSeriesExplorer.singleTimeSeriesAnalysisTitle', @@ -1095,7 +1096,7 @@ export class TimeSeriesExplorer extends React.Component {   {chartDetails.entityData.count === 1 && ( - + {chartDetails.entityData.entities.length > 0 && '('} {chartDetails.entityData.entities .map((entity) => { @@ -1103,10 +1104,10 @@ export class TimeSeriesExplorer extends React.Component { }) .join(', ')} {chartDetails.entityData.entities.length > 0 && ')'} - + )} {chartDetails.entityData.count !== 1 && ( - + {chartDetails.entityData.entities.map((countData, i) => { return ( @@ -1134,107 +1135,107 @@ export class TimeSeriesExplorer extends React.Component { ); })} - + )}

+ + + + + + + + {showModelBoundsCheckbox && ( - + - - - {showModelBoundsCheckbox && ( - - - - )} - - {showAnnotationsCheckbox && ( - - + + + )} + + {showForecastCheckbox && ( + + + {i18n.translate('xpack.ml.timeSeriesExplorer.showForecastLabel', { + defaultMessage: 'show forecast', + })} + + } + checked={showForecast} + onChange={this.toggleShowForecastHandler} + /> + + )} + + + + {focusAnnotationError !== undefined && ( + <> + +

+ - - )} - - {showForecastCheckbox && ( - - - {i18n.translate('xpack.ml.timeSeriesExplorer.showForecastLabel', { - defaultMessage: 'show forecast', - })} - +

+ + + - - )} - - - - {focusAnnotationError !== undefined && ( - <> - -

- -

- - - -

{focusAnnotationError}

- - - - - )} - {focusAnnotationData && focusAnnotationData.length > 0 && ( +

{focusAnnotationError}

+ + + + + )} + {focusAnnotationData && focusAnnotationData.length > 0 && ( + <> +

- - )} - - -

- -

- - - - - - - - - - -

+ + + )} + + +

+ +

+ + + + + + + + + + +
)} {arePartitioningFieldsProvided && jobs.length > 0 && hasResults === true && ( diff --git a/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer_help_popover.tsx b/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer_help_popover.tsx index 778c7cc5d58a3..4313c9b228825 100644 --- a/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer_help_popover.tsx +++ b/x-pack/plugins/ml/public/application/timeseriesexplorer/timeseriesexplorer_help_popover.tsx @@ -5,26 +5,15 @@ * 2.0. */ -import React, { useState } from 'react'; +import React from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; -import { HelpPopover, HelpPopoverButton } from '../components/help_popover/help_popover'; +import { HelpPopover } from '../components/help_popover/help_popover'; export const TimeSeriesExplorerHelpPopover = () => { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); - return ( { - setIsPopoverOpen(!isPopoverOpen); - }} - /> - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} title={i18n.translate('xpack.ml.timeSeriesExplorer.popoverTitle', { defaultMessage: 'Single time series analysis', })} diff --git a/x-pack/plugins/ml/public/application/util/index_utils.ts b/x-pack/plugins/ml/public/application/util/index_utils.ts index 89b35624f11a9..df9be6535da3e 100644 --- a/x-pack/plugins/ml/public/application/util/index_utils.ts +++ b/x-pack/plugins/ml/public/application/util/index_utils.ts @@ -6,7 +6,7 @@ */ import { i18n } from '@kbn/i18n'; -import type { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import type { DataView, DataViewsContract } from '@kbn/data-views-plugin/public'; import type { SavedSearchSavedObject } from '../../../common/types/kibana'; import { getToastNotifications, getSavedObjectsClient } from './dependency_cache'; diff --git a/x-pack/plugins/ml/public/embeddables/lens/lens_vis_layer_selection_flyout/flyout_body.tsx b/x-pack/plugins/ml/public/embeddables/lens/lens_vis_layer_selection_flyout/flyout_body.tsx index c6f0ec7ccec6f..8f0587dffcdf3 100644 --- a/x-pack/plugins/ml/public/embeddables/lens/lens_vis_layer_selection_flyout/flyout_body.tsx +++ b/x-pack/plugins/ml/public/embeddables/lens/lens_vis_layer_selection_flyout/flyout_body.tsx @@ -42,7 +42,7 @@ export const FlyoutBody: FC = ({ onClose, layerResults, embeddable, share return ( <> {layerResults.map((layer, i) => ( - <> + @@ -62,7 +62,7 @@ export const FlyoutBody: FC = ({ onClose, layerResults, embeddable, share {layer.isCompatible ? ( <> - + @@ -90,6 +90,7 @@ export const FlyoutBody: FC = ({ onClose, layerResults, embeddable, share color="success" iconType="popout" iconSide="right" + data-test-subj={`mlLensLayerCompatibleButton_${i}`} > = ({ onClose, layerResults, embeddable, share ) : ( <> - + @@ -123,7 +128,7 @@ export const FlyoutBody: FC = ({ onClose, layerResults, embeddable, share - + ))} ); diff --git a/x-pack/plugins/ml/public/embeddables/lens/show_flyout.tsx b/x-pack/plugins/ml/public/embeddables/lens/show_flyout.tsx index b77938408fa37..81a9cfcf9dc8e 100644 --- a/x-pack/plugins/ml/public/embeddables/lens/show_flyout.tsx +++ b/x-pack/plugins/ml/public/embeddables/lens/show_flyout.tsx @@ -77,7 +77,7 @@ export async function showLensVisToADJobFlyout( ) ), { - 'data-test-subj': 'mlFlyoutJobSelector', + 'data-test-subj': 'mlFlyoutLensLayerSelector', ownFocus: true, closeButtonAriaLabel: 'jobSelectorFlyout', onClose: onFlyoutClose, diff --git a/x-pack/plugins/ml/public/embeddables/types.ts b/x-pack/plugins/ml/public/embeddables/types.ts index 228ce092d4cec..2ba4af15f7466 100644 --- a/x-pack/plugins/ml/public/embeddables/types.ts +++ b/x-pack/plugins/ml/public/embeddables/types.ts @@ -6,8 +6,8 @@ */ import type { CoreStart } from '@kbn/core/public'; -import type { Filter, Query } from '@kbn/es-query'; -import type { RefreshInterval, TimeRange } from '@kbn/data-plugin/common'; +import type { Filter, Query, TimeRange } from '@kbn/es-query'; +import type { RefreshInterval } from '@kbn/data-plugin/common'; import type { EmbeddableInput, EmbeddableOutput, IEmbeddable } from '@kbn/embeddable-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/common'; import type { JobId } from '../../common/types/anomaly_detection_jobs'; diff --git a/x-pack/plugins/ml/public/ui_actions/apply_entity_filters_action.tsx b/x-pack/plugins/ml/public/ui_actions/apply_entity_filters_action.tsx index 61556df53db2e..ad62b94419f20 100644 --- a/x-pack/plugins/ml/public/ui_actions/apply_entity_filters_action.tsx +++ b/x-pack/plugins/ml/public/ui_actions/apply_entity_filters_action.tsx @@ -5,10 +5,9 @@ * 2.0. */ -import { Filter } from '@kbn/es-query'; +import { Filter, FilterStateStore } from '@kbn/es-query'; import { i18n } from '@kbn/i18n'; import { createAction } from '@kbn/ui-actions-plugin/public'; -import { FilterStateStore } from '@kbn/data-plugin/common'; import { MlCoreSetup } from '../plugin'; import { ANOMALY_EXPLORER_CHARTS_EMBEDDABLE_TYPE, diff --git a/x-pack/plugins/ml/public/ui_actions/apply_influencer_filters_action.tsx b/x-pack/plugins/ml/public/ui_actions/apply_influencer_filters_action.tsx index 3b07b1bf06d95..dc574b48849e4 100644 --- a/x-pack/plugins/ml/public/ui_actions/apply_influencer_filters_action.tsx +++ b/x-pack/plugins/ml/public/ui_actions/apply_influencer_filters_action.tsx @@ -5,10 +5,9 @@ * 2.0. */ -import { Filter } from '@kbn/es-query'; +import { Filter, FilterStateStore } from '@kbn/es-query'; import { i18n } from '@kbn/i18n'; import { createAction } from '@kbn/ui-actions-plugin/public'; -import { FilterStateStore } from '@kbn/data-plugin/common'; import { MlCoreSetup } from '../plugin'; import { SWIMLANE_TYPE, VIEW_BY_JOB_LABEL } from '../application/explorer/explorer_constants'; import { ANOMALY_SWIMLANE_EMBEDDABLE_TYPE, SwimLaneDrilldownContext } from '../embeddables'; diff --git a/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx b/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx index 6abbc5718ad61..71180f2c2c92d 100644 --- a/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx +++ b/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx @@ -5,7 +5,8 @@ * 2.0. */ import React, { createContext } from 'react'; -import { TimeRange, RefreshInterval } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { RefreshInterval } from '@kbn/data-plugin/public'; import { GlobalState } from '../../url_state'; import { MonitoringStartPluginDependencies, MonitoringStartServices } from '../../types'; import { Legacy } from '../../legacy_shims'; diff --git a/x-pack/plugins/monitoring/public/url_state.ts b/x-pack/plugins/monitoring/public/url_state.ts index e19758d882124..9c2e4b6ce7ce3 100644 --- a/x-pack/plugins/monitoring/public/url_state.ts +++ b/x-pack/plugins/monitoring/public/url_state.ts @@ -6,7 +6,8 @@ */ import { Subscription } from 'rxjs'; import { History, createHashHistory } from 'history'; -import { RefreshInterval, TimeRange, syncQueryStateWithUrl } from '@kbn/data-plugin/public'; +import type { TimeRange } from '@kbn/es-query'; +import { RefreshInterval, syncQueryStateWithUrl } from '@kbn/data-plugin/public'; import { createStateContainer, createKbnUrlStateStorage, diff --git a/x-pack/plugins/monitoring/server/lib/metrics/__snapshots__/metrics.test.js.snap b/x-pack/plugins/monitoring/server/lib/metrics/__snapshots__/metrics.test.js.snap index 91f4779509af2..068b849f0a1a1 100644 --- a/x-pack/plugins/monitoring/server/lib/metrics/__snapshots__/metrics.test.js.snap +++ b/x-pack/plugins/monitoring/server/lib/metrics/__snapshots__/metrics.test.js.snap @@ -6034,6 +6034,31 @@ Object { "path": "logstash_stats.pipelines", }, }, + "pipelines_mb": Object { + "aggs": Object { + "pipeline_by_id": Object { + "aggs": Object { + "queue_size_field": Object { + "max": Object { + "field": "logstash.node.stats.pipelines.queue.max_queue_size_in_bytes", + }, + }, + }, + "terms": Object { + "field": "logstash.node.stats.pipelines.id", + "size": 1000, + }, + }, + "total_queue_size_for_node": Object { + "sum_bucket": Object { + "buckets_path": "pipeline_by_id>queue_size_field", + }, + }, + }, + "nested": Object { + "path": "logstash.node.stats.pipelines", + }, + }, }, "derivative": false, "description": "Maximum size set for the persistent queues on this node.", @@ -6044,7 +6069,7 @@ Object { "getDateHistogramSubAggs": undefined, "isNotSupportedInInternalCollection": undefined, "label": "Max Queue Size", - "mbField": undefined, + "mbField": "logstash.node.stats.pipelines.queue.max_queue_size_in_bytes", "metricAgg": undefined, "periodsField": undefined, "quotaField": undefined, @@ -6083,6 +6108,31 @@ Object { "path": "logstash_stats.pipelines", }, }, + "pipelines_mb": Object { + "aggs": Object { + "pipeline_by_id": Object { + "aggs": Object { + "queue_size_field": Object { + "max": Object { + "field": "logstash.node.stats.pipelines.queue.queue_size_in_bytes", + }, + }, + }, + "terms": Object { + "field": "logstash.node.stats.pipelines.id", + "size": 1000, + }, + }, + "total_queue_size_for_node": Object { + "sum_bucket": Object { + "buckets_path": "pipeline_by_id>queue_size_field", + }, + }, + }, + "nested": Object { + "path": "logstash.node.stats.pipelines", + }, + }, }, "derivative": false, "description": "Current size of all persistent queues in the Logstash pipelines on this node.", @@ -6093,7 +6143,7 @@ Object { "getDateHistogramSubAggs": undefined, "isNotSupportedInInternalCollection": undefined, "label": "Queue Size", - "mbField": undefined, + "mbField": "logstash.node.stats.pipelines.queue.queue_size_in_bytes", "metricAgg": undefined, "periodsField": undefined, "quotaField": undefined, diff --git a/x-pack/plugins/monitoring/server/lib/metrics/logstash/classes.ts b/x-pack/plugins/monitoring/server/lib/metrics/logstash/classes.ts index 6fcd757e3c6c3..790f761637dbd 100644 --- a/x-pack/plugins/monitoring/server/lib/metrics/logstash/classes.ts +++ b/x-pack/plugins/monitoring/server/lib/metrics/logstash/classes.ts @@ -240,7 +240,7 @@ export class LogstashEventsRateMetric extends LogstashMetric { type LogstashPipelineQueueSizeMetricOptions = Pick< MetricOptions, - 'field' | 'label' | 'description' | 'format' | 'units' + 'field' | 'label' | 'description' | 'format' | 'units' | 'mbField' > & Partial>; @@ -274,9 +274,36 @@ export class LogstashPipelineQueueSizeMetric extends LogstashMetric { }, }, }, + pipelines_mb: { + nested: { + path: 'logstash.node.stats.pipelines', + }, + aggs: { + pipeline_by_id: { + terms: { + field: 'logstash.node.stats.pipelines.id', + size: 1000, + }, + aggs: { + queue_size_field: { + max: { + field: this.mbField, + }, + }, + }, + }, + total_queue_size_for_node: { + sum_bucket: { + buckets_path: 'pipeline_by_id>queue_size_field', + }, + }, + }, + }, }; this.calculation = (bucket: object) => { - return _.get(bucket, 'pipelines.total_queue_size_for_node.value'); + const legacyQueueSize = _.get(bucket, 'pipelines.total_queue_size_for_node.value'); + const mbQueueSize = _.get(bucket, 'pipelines_mb.total_queue_size_for_node.value'); + return Math.max(legacyQueueSize, mbQueueSize); }; } } diff --git a/x-pack/plugins/monitoring/server/lib/metrics/logstash/metrics.ts b/x-pack/plugins/monitoring/server/lib/metrics/logstash/metrics.ts index 87024a6de86ab..97119289d2139 100644 --- a/x-pack/plugins/monitoring/server/lib/metrics/logstash/metrics.ts +++ b/x-pack/plugins/monitoring/server/lib/metrics/logstash/metrics.ts @@ -402,6 +402,7 @@ export const metrics = { }), logstash_pipeline_queue_size: new LogstashPipelineQueueSizeMetric({ field: 'logstash_stats.pipelines.queue.queue_size_in_bytes', + mbField: 'logstash.node.stats.pipelines.queue.queue_size_in_bytes', label: i18n.translate('xpack.monitoring.metrics.logstashInstance.queueSizeLabel', { defaultMessage: 'Queue Size', }), @@ -417,6 +418,7 @@ export const metrics = { }), logstash_pipeline_max_queue_size: new LogstashPipelineQueueSizeMetric({ field: 'logstash_stats.pipelines.queue.max_queue_size_in_bytes', + mbField: 'logstash.node.stats.pipelines.queue.max_queue_size_in_bytes', label: i18n.translate('xpack.monitoring.metrics.logstashInstance.maxQueueSizeLabel', { defaultMessage: 'Max Queue Size', }), diff --git a/x-pack/plugins/observability/public/pages/rule_details/index.tsx b/x-pack/plugins/observability/public/pages/rule_details/index.tsx index e88467b225e9e..a1edf0f1dd2f9 100644 --- a/x-pack/plugins/observability/public/pages/rule_details/index.tsx +++ b/x-pack/plugins/observability/public/pages/rule_details/index.tsx @@ -255,10 +255,10 @@ export function RuleDetailsPage() { disableRule: async () => await disableRule({ http, id: rule.id }), onRuleChanged: () => reloadRule(), isEditable: hasEditButton, - snoozeRule: async (snoozeEndTime: string | -1) => { - await snoozeRule({ http, id: rule.id, snoozeEndTime }); + snoozeRule: async (snoozeSchedule) => { + await snoozeRule({ http, id: rule.id, snoozeSchedule }); }, - unsnoozeRule: async () => await unsnoozeRule({ http, id: rule.id }), + unsnoozeRule: async (scheduleIds) => await unsnoozeRule({ http, id: rule.id, scheduleIds }), }); const getNotifyText = () => diff --git a/x-pack/plugins/observability/public/pages/rules/index.tsx b/x-pack/plugins/observability/public/pages/rules/index.tsx index 6c63eb41a633f..f4d6a3c10eeb0 100644 --- a/x-pack/plugins/observability/public/pages/rules/index.tsx +++ b/x-pack/plugins/observability/public/pages/rules/index.tsx @@ -241,10 +241,11 @@ function RulesPage() { disableRule: async () => await disableRule({ http, id: item.id }), onRuleChanged: () => reload(), isEditable: item.isEditable && isRuleTypeEditableInContext(item.ruleTypeId), - snoozeRule: async (snoozeEndTime: string | -1) => { - await snoozeRule({ http, id: item.id, snoozeEndTime }); + snoozeRule: async (snoozeSchedule) => { + await snoozeRule({ http, id: item.id, snoozeSchedule }); }, - unsnoozeRule: async () => await unsnoozeRule({ http, id: item.id }), + unsnoozeRule: async (scheduleIds) => + await unsnoozeRule({ http, id: item.id, scheduleIds }), }); }, }, diff --git a/x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx b/x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx index ca294c044d05b..c53117f0c9484 100644 --- a/x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx +++ b/x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx @@ -7,7 +7,7 @@ import { useCallback, useEffect, useState } from 'react'; -import { FilterStateStore } from '@kbn/data-plugin/common'; +import { FilterStateStore } from '@kbn/es-query'; import { useKibana, isModifiedEvent, isLeftClickEvent } from '../lib/kibana'; interface UseDiscoverLink { diff --git a/x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx b/x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx index dc54be07f49eb..2dd2a0b85d590 100644 --- a/x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx +++ b/x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx @@ -31,7 +31,8 @@ import type { TermsIndexPatternColumn, } from '@kbn/lens-plugin/public'; import { DOCUMENT_FIELD_NAME as RECORDS_FIELD } from '@kbn/lens-plugin/common/constants'; -import { FilterStateStore, DataView } from '@kbn/data-plugin/common'; +import { FilterStateStore } from '@kbn/es-query'; +import { DataView } from '@kbn/data-plugin/common'; import { removeMultilines } from '../../common/utils/build_query/remove_multilines'; import { useKibana } from '../common/lib/kibana'; import { OsqueryManagerPackagePolicyInputStream } from '../../common/types'; diff --git a/x-pack/plugins/security_solution/common/endpoint/constants.ts b/x-pack/plugins/security_solution/common/endpoint/constants.ts index 13747e53025c7..6d4a3407e644b 100644 --- a/x-pack/plugins/security_solution/common/endpoint/constants.ts +++ b/x-pack/plugins/security_solution/common/endpoint/constants.ts @@ -58,7 +58,7 @@ const BASE_ENDPOINT_ACTION_ROUTE = `${BASE_ENDPOINT_ROUTE}/action`; /** Action Response Routes */ export const ISOLATE_HOST_ROUTE_V2 = `${BASE_ENDPOINT_ACTION_ROUTE}/isolate`; -export const RELEASE_HOST_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/release`; +export const UNISOLATE_HOST_ROUTE_V2 = `${BASE_ENDPOINT_ACTION_ROUTE}/unisolate`; export const GET_RUNNING_PROCESSES_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/running_procs`; export const KILL_PROCESS_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/kill_process`; export const SUSPEND_PROCESS_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/suspend_process`; diff --git a/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts b/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts index 60cab431a5444..d3f47421d7d7c 100644 --- a/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts +++ b/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts @@ -9,7 +9,7 @@ import uuid from 'uuid'; import { EndpointActionListRequestSchema, - HostIsolationRequestSchema, + NoParametersRequestSchema, KillOrSuspendProcessRequestSchema, } from './actions'; @@ -147,16 +147,16 @@ describe('actions schemas', () => { }); }); - describe('HostIsolationRequestSchema', () => { + describe('NoParametersRequestSchema', () => { it('should require at least 1 Endpoint ID', () => { expect(() => { - HostIsolationRequestSchema.body.validate({}); + NoParametersRequestSchema.body.validate({}); }).toThrow(); }); it('should accept an Endpoint ID as the only required field', () => { expect(() => { - HostIsolationRequestSchema.body.validate({ + NoParametersRequestSchema.body.validate({ endpoint_ids: ['ABC-XYZ-000'], }); }).not.toThrow(); @@ -164,7 +164,7 @@ describe('actions schemas', () => { it('should accept a comment', () => { expect(() => { - HostIsolationRequestSchema.body.validate({ + NoParametersRequestSchema.body.validate({ endpoint_ids: ['ABC-XYZ-000'], comment: 'a user comment', }); @@ -173,7 +173,7 @@ describe('actions schemas', () => { it('should accept alert IDs', () => { expect(() => { - HostIsolationRequestSchema.body.validate({ + NoParametersRequestSchema.body.validate({ endpoint_ids: ['ABC-XYZ-000'], alert_ids: ['0000000-000-00'], }); @@ -182,7 +182,7 @@ describe('actions schemas', () => { it('should accept case IDs', () => { expect(() => { - HostIsolationRequestSchema.body.validate({ + NoParametersRequestSchema.body.validate({ endpoint_ids: ['ABC-XYZ-000'], case_ids: ['000000000-000-000'], }); @@ -193,7 +193,7 @@ describe('actions schemas', () => { describe('KillOrSuspendProcessRequestSchema', () => { it('should require at least 1 Endpoint ID', () => { expect(() => { - HostIsolationRequestSchema.body.validate({}); + NoParametersRequestSchema.body.validate({}); }).toThrow(); }); diff --git a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts index c4dfa7a5b434c..cf190e5c62ca2 100644 --- a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts @@ -18,7 +18,7 @@ const BaseActionRequestSchema = { parameters: schema.maybe(schema.object({})), }; -export const HostIsolationRequestSchema = { +export const NoParametersRequestSchema = { body: schema.object({ ...BaseActionRequestSchema }), }; @@ -33,7 +33,7 @@ export const KillOrSuspendProcessRequestSchema = { }; export const ResponseActionBodySchema = schema.oneOf([ - HostIsolationRequestSchema.body, + NoParametersRequestSchema.body, KillOrSuspendProcessRequestSchema.body, ]); diff --git a/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.test.ts b/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.test.ts index 0389ac8e216ae..acf71fa584198 100644 --- a/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.test.ts +++ b/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.test.ts @@ -30,6 +30,7 @@ describe('Endpoint Authz service', () => { ['canUnIsolateHost'], ['canKillProcess'], ['canSuspendProcess'], + ['canGetRunningProcesses'], ])('should set `%s` to `true`', (authProperty) => { expect(calculateEndpointAuthz(licenseService, fleetAuthz, userRoles)[authProperty]).toBe( true @@ -60,6 +61,14 @@ describe('Endpoint Authz service', () => { ).toBe(false); }); + it('should set `canGetRunningProcesses` to false if not proper license', () => { + licenseService.isPlatinumPlus.mockReturnValue(false); + + expect( + calculateEndpointAuthz(licenseService, fleetAuthz, userRoles).canGetRunningProcesses + ).toBe(false); + }); + it('should set `canUnIsolateHost` to true even if not proper license', () => { licenseService.isPlatinumPlus.mockReturnValue(false); @@ -82,6 +91,7 @@ describe('Endpoint Authz service', () => { ['canUnIsolateHost'], ['canKillProcess'], ['canSuspendProcess'], + ['canGetRunningProcesses'], ])('should set `%s` to `false`', (authProperty) => { expect(calculateEndpointAuthz(licenseService, fleetAuthz, userRoles)[authProperty]).toBe( false @@ -108,6 +118,7 @@ describe('Endpoint Authz service', () => { canCreateArtifactsByPolicy: false, canKillProcess: false, canSuspendProcess: false, + canGetRunningProcesses: false, }); }); }); diff --git a/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.ts b/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.ts index 5acf3e5df1975..6015d621714a1 100644 --- a/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.ts +++ b/x-pack/plugins/security_solution/common/endpoint/service/authz/authz.ts @@ -34,6 +34,7 @@ export const calculateEndpointAuthz = ( canUnIsolateHost: hasAllAccessToFleet, canKillProcess: hasAllAccessToFleet && isPlatinumPlusLicense, canSuspendProcess: hasAllAccessToFleet && isPlatinumPlusLicense, + canGetRunningProcesses: hasAllAccessToFleet && isPlatinumPlusLicense, }; }; @@ -46,5 +47,6 @@ export const getEndpointAuthzInitialState = (): EndpointAuthz => { canUnIsolateHost: true, canKillProcess: false, canSuspendProcess: false, + canGetRunningProcesses: false, }; }; diff --git a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts index 2dd82d7609de4..ee07e05bac2d3 100644 --- a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts @@ -8,13 +8,17 @@ import { TypeOf } from '@kbn/config-schema'; import { ActionStatusRequestSchema, - HostIsolationRequestSchema, + NoParametersRequestSchema, ResponseActionBodySchema, } from '../schema/actions'; export type ISOLATION_ACTIONS = 'isolate' | 'unisolate'; -export type ResponseActions = ISOLATION_ACTIONS | 'kill-process' | 'suspend-process'; +export type ResponseActions = + | ISOLATION_ACTIONS + | 'kill-process' + | 'suspend-process' + | 'running-processes'; export const ActivityLogItemTypes = { ACTION: 'action' as const, @@ -189,7 +193,7 @@ export interface ActivityLog { data: ActivityLogEntry[]; } -export type HostIsolationRequestBody = TypeOf; +export type HostIsolationRequestBody = TypeOf; export type ResponseActionRequestBody = TypeOf; diff --git a/x-pack/plugins/security_solution/common/endpoint/types/authz.ts b/x-pack/plugins/security_solution/common/endpoint/types/authz.ts index 3f7a50537177f..054f6ab99aa89 100644 --- a/x-pack/plugins/security_solution/common/endpoint/types/authz.ts +++ b/x-pack/plugins/security_solution/common/endpoint/types/authz.ts @@ -24,6 +24,8 @@ export interface EndpointAuthz { canKillProcess: boolean; /** If user has permissions to suspend process on hosts */ canSuspendProcess: boolean; + /** If user has permissions to get running processes on hosts */ + canGetRunningProcesses: boolean; } export type EndpointAuthzKeyList = Array; diff --git a/x-pack/plugins/security_solution/common/types/timeline/index.ts b/x-pack/plugins/security_solution/common/types/timeline/index.ts index 3d4d1b5dc28cb..9b1405b78a57d 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/index.ts +++ b/x-pack/plugins/security_solution/common/types/timeline/index.ts @@ -327,6 +327,7 @@ export enum TimelineId { test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', rulePreview = 'rule-preview', + kubernetesPageSessions = 'kubernetes-page-sessions', } export const TimelineIdLiteralRt = runtimeTypes.union([ @@ -341,6 +342,7 @@ export const TimelineIdLiteralRt = runtimeTypes.union([ runtimeTypes.literal(TimelineId.active), runtimeTypes.literal(TimelineId.test), runtimeTypes.literal(TimelineId.rulePreview), + runtimeTypes.literal(TimelineId.kubernetesPageSessions), ]); export type TimelineIdLiteral = runtimeTypes.TypeOf; diff --git a/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx b/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx index 02da384556c78..feb9cf30afc4f 100644 --- a/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx @@ -8,11 +8,10 @@ import React, { memo, useMemo, useCallback } from 'react'; import deepEqual from 'fast-deep-equal'; -import type { DataViewBase, Filter, Query } from '@kbn/es-query'; +import type { DataViewBase, Filter, Query, TimeRange } from '@kbn/es-query'; import { FilterManager, TimeHistory, - TimeRange, SavedQuery, SavedQueryTimeFilter, } from '@kbn/data-plugin/public'; diff --git a/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx b/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx index d5e9fba36361a..2c2e1c5cfcc19 100644 --- a/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx @@ -13,8 +13,8 @@ import { Dispatch } from 'redux'; import { Subscription } from 'rxjs'; import deepEqual from 'fast-deep-equal'; -import type { DataViewBase, Filter, Query } from '@kbn/es-query'; -import type { FilterManager, TimeRange, SavedQuery } from '@kbn/data-plugin/public'; +import type { DataViewBase, Filter, Query, TimeRange } from '@kbn/es-query'; +import type { FilterManager, SavedQuery } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { OnTimeChangeProps } from '@elastic/eui'; diff --git a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts index 4c045e358e1d6..0e7bdd7d1f540 100644 --- a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts +++ b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts @@ -59,10 +59,13 @@ export const sessionsHeaders: ColumnHeaderOptions[] = [ }, ]; -export const sessionsDefaultModel: SubsetTimelineModel = { +export const getSessionsDefaultModel = ( + columns: ColumnHeaderOptions[], + defaultColumns: ColumnHeaderOptions[] +): SubsetTimelineModel => ({ ...timelineDefaults, - columns: sessionsHeaders, - defaultColumns: sessionsHeaders, + columns, + defaultColumns, excludedRowRendererIds: Object.values(RowRendererId), sort: [ { @@ -71,4 +74,4 @@ export const sessionsDefaultModel: SubsetTimelineModel = { sortDirection: 'desc', }, ], -}; +}); diff --git a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx index 4d89b969e5c17..6d3038e4554ed 100644 --- a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx @@ -10,7 +10,7 @@ import type { Filter } from '@kbn/es-query'; import { SessionsComponentsProps } from './types'; import { ESBoolQuery } from '../../../../common/typed_json'; import { StatefulEventsViewer } from '../events_viewer'; -import { sessionsDefaultModel } from './default_headers'; +import { getSessionsDefaultModel, sessionsHeaders } from './default_headers'; import { defaultRowRenderers } from '../../../timelines/components/timeline/body/renderers'; import { DefaultCellRenderer } from '../../../timelines/components/timeline/cell_rendering/default_cell_renderer'; import * as i18n from './translations'; @@ -48,6 +48,8 @@ const SessionsViewComponent: React.FC = ({ pageFilters, startDate, filterQuery, + columns = sessionsHeaders, + defaultColumns = sessionsHeaders, }) => { const parsedFilterQuery: ESBoolQuery = useMemo(() => { if (filterQuery && filterQuery !== '') { @@ -83,7 +85,7 @@ const SessionsViewComponent: React.FC = ({
{ timelineId: TimelineIdLiteral; @@ -15,4 +15,6 @@ export interface SessionsComponentsProps extends Pick x !== TimelineId.active); diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts b/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts new file mode 100644 index 0000000000000..c7120947a9182 --- /dev/null +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts @@ -0,0 +1,64 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ColumnHeaderOptions } from '../../../common/types/timeline'; +import { defaultColumnHeaderType } from '../../timelines/components/timeline/body/column_headers/default_headers'; +import { DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../timelines/components/timeline/body/constants'; +import { + COLUMN_SESSION_START, + COLUMN_EXECUTABLE, + COLUMN_ENTRY_USER, + COLUMN_INTERACTIVE, + COLUMN_ENTRY_TYPE, + COLUMN_NODE, + COLUMN_CONTAINER, + COLUMN_POD, +} from './translations'; + +export const kubernetesSessionsHeaders: ColumnHeaderOptions[] = [ + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.start', + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + display: COLUMN_SESSION_START, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.user.name', + display: COLUMN_ENTRY_USER, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.executable', + display: COLUMN_EXECUTABLE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'cloud.instance.name', + display: COLUMN_NODE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.entry_meta.type', + display: COLUMN_ENTRY_TYPE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.interactive', + display: COLUMN_INTERACTIVE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'container.name', + display: COLUMN_CONTAINER, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'orchestrator.resource.name', + display: COLUMN_POD, + }, +]; diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx b/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx index 59ba4fa340e21..0176355b6672f 100644 --- a/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { useMemo } from 'react'; +import React, { useCallback, useMemo } from 'react'; import { getEsQueryConfig } from '@kbn/data-plugin/common'; import { SecuritySolutionPageWrapper } from '../../common/components/page_wrapper'; import { useKibana } from '../../common/lib/kibana'; @@ -21,6 +21,9 @@ import { useGlobalTime } from '../../common/containers/use_global_time'; import { useDeepEqualSelector } from '../../common/hooks/use_selector'; import { convertToBuildEsQuery } from '../../common/lib/keury'; import { useInvalidFilterQuery } from '../../common/hooks/use_invalid_filter_query'; +import { SessionsView } from '../../common/components/sessions_viewer'; +import { TimelineId } from '../../../common/types/timeline'; +import { kubernetesSessionsHeaders } from './constants'; export const KubernetesContainer = React.memo(() => { const { kubernetesSecurity, uiSettings } = useKibana().services; @@ -60,6 +63,21 @@ export const KubernetesContainer = React.memo(() => { endDate: to, }); + const renderSessionsView = useCallback( + (sessionsFilterQuery: string | undefined) => ( + + ), + [from, to] + ); + return ( {kubernetesSecurity.getKubernetesPage({ @@ -74,6 +92,7 @@ export const KubernetesContainer = React.memo(() => { startDate: from, endDate: to, }, + renderSessionsView, })} diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts b/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts new file mode 100644 index 0000000000000..1b2c308c0bfa6 --- /dev/null +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts @@ -0,0 +1,57 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const COLUMN_SESSION_START = i18n.translate( + 'xpack.securitySolution.kubernetes.columnSessionStart', + { + defaultMessage: 'Date connected', + } +); + +export const COLUMN_EXECUTABLE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnExecutable', + { + defaultMessage: 'Session leader', + } +); + +export const COLUMN_NODE = i18n.translate('xpack.securitySolution.kubernetes.columnNode', { + defaultMessage: 'Node', +}); + +export const COLUMN_ENTRY_USER = i18n.translate( + 'xpack.securitySolution.kubernetes.columnEntryUser', + { + defaultMessage: 'Session entry users', + } +); + +export const COLUMN_INTERACTIVE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnInteractive', + { + defaultMessage: 'Interactivity', + } +); + +export const COLUMN_ENTRY_TYPE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnEntryType', + { + defaultMessage: 'Entry mechanism', + } +); + +export const COLUMN_CONTAINER = i18n.translate( + 'xpack.securitySolution.kubernetes.columnContainer', + { + defaultMessage: 'Container', + } +); +export const COLUMN_POD = i18n.translate('xpack.securitySolution.kubernetes.columnPod', { + defaultMessage: 'Pod', +}); diff --git a/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx b/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx index 707afeea81cc8..21a3f6d9ce066 100644 --- a/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx +++ b/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx @@ -17,6 +17,7 @@ import { EuiSpacer, EuiText, EuiDescriptionList, + EuiHorizontalRule, EuiTextColor, EuiTitle, } from '@elastic/eui'; @@ -330,20 +331,12 @@ const StyledDescriptiveName = memo(styled(EuiText)` `); const StyledFlexTitle = memo(styled('h3')` + align-items: center; display: flex; flex-flow: row; font-size: 1.2em; `); -const StyledTitleRule = memo(styled('hr')` - &.euiHorizontalRule.euiHorizontalRule--full.euiHorizontalRule--marginSmall.override { - display: block; - flex: 1; - margin-left: 0.5em; - } -`); const TitleHr = memo(() => { - return ( - - ); + return ; }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.test.tsx index 5f2f47073be6c..d1f7740268313 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.test.tsx @@ -19,7 +19,7 @@ const renderUseCreateFieldButton = (props: Partial = renderHook>( () => useCreateFieldButton({ - hasFieldEditPermission: true, + isAllowed: true, loading: false, openFieldEditor: mockOpenFieldEditor, ...props, @@ -40,7 +40,7 @@ describe('useCreateFieldButton', () => { }); it('should return the undefined when user do not has edit permissions', async () => { - const { result } = renderUseCreateFieldButton({ hasFieldEditPermission: false }); + const { result } = renderUseCreateFieldButton({ isAllowed: false }); expect(result.current).toBeUndefined(); }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx index f20e7dce7d8bd..05bc3992791f6 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx @@ -18,7 +18,7 @@ const StyledButton = styled(EuiButton)` `; export interface UseCreateFieldButtonProps { - hasFieldEditPermission: boolean; + isAllowed: boolean; loading: boolean; openFieldEditor: OpenFieldEditor; } @@ -30,7 +30,7 @@ export type UseCreateFieldButton = ( * Returns a memoised 'CreateFieldButton' with only an 'onClick' property. */ export const useCreateFieldButton: UseCreateFieldButton = ({ - hasFieldEditPermission, + isAllowed, loading, openFieldEditor, }) => { @@ -52,5 +52,5 @@ export const useCreateFieldButton: UseCreateFieldButton = ({ [loading, openFieldEditor] ); - return hasFieldEditPermission ? createFieldButton : undefined; + return isAllowed ? createFieldButton : undefined; }; diff --git a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.test.tsx index 8f4fc13ddbe3b..6539383639fe0 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.test.tsx @@ -34,6 +34,22 @@ let mockIndexPatternFieldEditor: Start; jest.mock('../../../common/lib/kibana'); const useKibanaMock = useKibana as jest.Mocked; +const defaultDataviewState: { + missingPatterns: string[]; + selectedDataViewId: string | null; +} = { + missingPatterns: [], + selectedDataViewId: 'security-solution', +}; +const mockScopeIdSelector = jest.fn(() => defaultDataviewState); +jest.mock('../../../common/store', () => { + const original = jest.requireActual('../../../common/store'); + return { + ...original, + sourcererSelectors: { scopeIdSelector: () => mockScopeIdSelector }, + }; +}); + const mockIndexFieldsSearch = jest.fn(); jest.mock('../../../common/containers/source/use_data_view', () => ({ useDataView: () => ({ @@ -100,6 +116,7 @@ describe('useFieldBrowserOptions', () => { ...useKibanaMock().services.application.capabilities, indexPatterns: { save: true }, }; + mockScopeIdSelector.mockReturnValue(defaultDataviewState); jest.clearAllMocks(); }); @@ -123,6 +140,22 @@ describe('useFieldBrowserOptions', () => { ); }); + it('should return the button when a dataView is present', async () => { + const { result } = renderUseFieldBrowserOptions(); + + expect(result.current.createFieldButton).toBeDefined(); + expect(result.current.getFieldTableColumns({ highlight: '', onHide: mockOnHide })).toHaveLength( + 5 + ); + }); + + it('should not return the button when a dataView is not present', () => { + mockScopeIdSelector.mockReturnValue({ missingPatterns: [], selectedDataViewId: null }); + const { result } = renderUseFieldBrowserOptions(); + + expect(result.current.createFieldButton).toBeUndefined(); + }); + it('should call onHide when button is pressed', async () => { useKibanaMock().services.data.dataViews.get = () => Promise.resolve({} as DataView); const { result } = await renderUpdatedUseFieldBrowserOptions(); diff --git a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.tsx index 35bb1f8e888fe..be67cb83e84b4 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/index.tsx @@ -155,7 +155,7 @@ export const useFieldBrowserOptions: UseFieldBrowserOptions = ({ ); const createFieldButton = useCreateFieldButton({ - hasFieldEditPermission, + isAllowed: hasFieldEditPermission && !!selectedDataViewId, loading: !dataView, openFieldEditor, }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.test.tsx new file mode 100644 index 0000000000000..96931cf940793 --- /dev/null +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.test.tsx @@ -0,0 +1,141 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { render } from '@testing-library/react'; + +import { TestProviders, mockTimelineModel } from '../../../../../common/mock'; +import { HeaderActions } from './header_actions'; +import { mockTimelines } from '../../../../../common/mock/mock_timelines_plugin'; +import { + ColumnHeaderOptions, + HeaderActionProps, + TimelineTabs, +} from '../../../../../../common/types/timeline'; +import { timelineActions } from '../../../../store/timeline'; +import { getColumnHeader } from '../column_headers/helpers'; + +jest.mock('../../../row_renderers_browser', () => ({ + StatefulRowRenderersBrowser: () => null, +})); + +const mockDispatch = jest.fn(); +jest.mock('react-redux', () => ({ + ...jest.requireActual('react-redux'), + useDispatch: () => mockDispatch, +})); + +jest.mock('../../../../../common/hooks/use_selector', () => ({ + useDeepEqualSelector: () => mockTimelineModel, + useShallowEqualSelector: jest.fn(), +})); + +const fieldId = 'test-field'; +const timelineId = 'test-timeline'; + +/* eslint-disable jsx-a11y/click-events-have-key-events */ +mockTimelines.getFieldBrowser.mockImplementation( + ({ + onToggleColumn, + onResetColumns, + }: { + onToggleColumn: (field: string) => void; + onResetColumns: () => void; + }) => ( +
+
onToggleColumn(fieldId)} /> +
+
+ ) +); + +jest.mock('../../../../../common/lib/kibana', () => ({ + useKibana: () => ({ + services: { + timelines: { ...mockTimelines }, + }, + }), +})); + +const defaultProps: HeaderActionProps = { + browserFields: {}, + columnHeaders: [], + isSelectAllChecked: false, + onSelectAll: jest.fn(), + showEventsSelect: false, + showSelectAllCheckbox: false, + sort: [], + tabType: TimelineTabs.query, + timelineId, + width: 10, +}; + +describe('HeaderActions', () => { + describe('FieldBrowser', () => { + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('should render the field browser', () => { + const result = render( + + + + ); + expect(result.getByTestId('mock-field-browser')).toBeInTheDocument(); + }); + + it('should dispatch upsertColumn when non existing column is toggled', () => { + const result = render( + + + + ); + result.getByTestId('mock-toggle-button').click(); + + expect(mockDispatch).toHaveBeenCalledWith( + timelineActions.upsertColumn({ + column: getColumnHeader(fieldId, []), + id: timelineId, + index: 1, + }) + ); + }); + + it('should dispatch removeColumn when existing column is toggled', () => { + const result = render( + + + + ); + result.getByTestId('mock-toggle-button').click(); + + expect(mockDispatch).toHaveBeenCalledWith( + timelineActions.removeColumn({ + columnId: fieldId, + id: timelineId, + }) + ); + }); + + it('should dispatch updateColumns when columns are reset', () => { + const result = render( + + + + ); + result.getByTestId('mock-reset-button').click(); + + expect(mockDispatch).toHaveBeenCalledWith( + timelineActions.updateColumns({ id: timelineId, columns: mockTimelineModel.defaultColumns }) + ); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx index c45059c909761..6d05e5304150e 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx @@ -29,13 +29,15 @@ import { useGlobalFullScreen, useTimelineFullScreen, } from '../../../../../common/containers/use_full_screen'; +import { useDeepEqualSelector } from '../../../../../common/hooks/use_selector'; import { StatefulRowRenderersBrowser } from '../../../row_renderers_browser'; import { EventsTh, EventsThContent } from '../../styles'; import { EventsSelect } from '../column_headers/events_select'; import * as i18n from '../column_headers/translations'; -import { timelineActions } from '../../../../store/timeline'; +import { timelineActions, timelineSelectors } from '../../../../store/timeline'; import { isFullScreen } from '../column_headers'; import { useKibana } from '../../../../../common/lib/kibana'; +import { getColumnHeader } from '../column_headers/helpers'; const SortingColumnsContainer = styled.div` button { @@ -92,6 +94,10 @@ const HeaderActionsComponent: React.FC = ({ const { globalFullScreen, setGlobalFullScreen } = useGlobalFullScreen(); const { timelineFullScreen, setTimelineFullScreen } = useTimelineFullScreen(); const dispatch = useDispatch(); + + const getManageTimeline = useMemo(() => timelineSelectors.getManageTimelineById(), []); + const { defaultColumns } = useDeepEqualSelector((state) => getManageTimeline(state, timelineId)); + const toggleFullScreen = useCallback(() => { if (timelineId === TimelineId.active) { setTimelineFullScreen(!timelineFullScreen); @@ -168,6 +174,32 @@ const HeaderActionsComponent: React.FC = ({ [columnHeaders] ); + const onResetColumns = useCallback(() => { + dispatch(timelineActions.updateColumns({ id: timelineId, columns: defaultColumns })); + }, [defaultColumns, dispatch, timelineId]); + + const onToggleColumn = useCallback( + (fieldId: string) => { + if (columnHeaders.some(({ id }) => id === fieldId)) { + dispatch( + timelineActions.removeColumn({ + columnId: fieldId, + id: timelineId, + }) + ); + } else { + dispatch( + timelineActions.upsertColumn({ + column: getColumnHeader(fieldId, defaultColumns), + id: timelineId, + index: 1, + }) + ); + } + }, + [columnHeaders, dispatch, timelineId, defaultColumns] + ); + const ColumnSorting = useDataGridColumnSorting(myColumns, sortedColumns, {}, [], displayValues); return ( @@ -190,7 +222,8 @@ const HeaderActionsComponent: React.FC = ({ {timelinesUi.getFieldBrowser({ browserFields, columnHeaders, - timelineId, + onResetColumns, + onToggleColumn, options: fieldBrowserOptions, })} diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.test.ts b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.test.ts index 2a23b5e993637..012ec4a058841 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.test.ts +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.test.ts @@ -11,7 +11,12 @@ import { BrowserFields } from '../../../../../../common/search_strategy'; import { ColumnHeaderOptions } from '../../../../../../common/types'; import { DEFAULT_COLUMN_MIN_WIDTH, DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../constants'; import { defaultHeaders } from './default_headers'; -import { getColumnWidthFromType, getColumnHeaders, getRootCategory } from './helpers'; +import { + getColumnWidthFromType, + getColumnHeaders, + getRootCategory, + getColumnHeader, +} from './helpers'; describe('helpers', () => { describe('getColumnWidthFromType', () => { @@ -50,6 +55,40 @@ describe('helpers', () => { }); }); + describe('getColumnHeader', () => { + test('it should return column header non existing in defaultHeaders', () => { + const field = 'test_field_1'; + + expect(getColumnHeader(field, [])).toEqual({ + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_COLUMN_MIN_WIDTH, + }); + }); + + test('it should return column header existing in defaultHeaders', () => { + const field = 'test_field_1'; + + expect( + getColumnHeader(field, [ + { + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + esTypes: ['date'], + type: 'date', + }, + ]) + ).toEqual({ + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + esTypes: ['date'], + type: 'date', + }); + }); + }); + describe('getColumnHeaders', () => { test('should return a full object of ColumnHeader from the default header', () => { const expectedData = [ diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.ts b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.ts index 1779c39ce7b31..42c74042b58ca 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.ts +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/column_headers/helpers.ts @@ -10,6 +10,7 @@ import { ColumnHeaderOptions } from '../../../../../../common/types'; import { BrowserFields } from '../../../../../common/containers/source'; import { DEFAULT_COLUMN_MIN_WIDTH, DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../constants'; +import { defaultColumnHeaderType } from './default_headers'; /** * Returns the root category for fields that are only one level, e.g. `_id` or `test_field_1` @@ -50,3 +51,16 @@ export const getColumnHeaders = ( export const getColumnWidthFromType = (type: string): number => type !== 'date' ? DEFAULT_COLUMN_MIN_WIDTH : DEFAULT_DATE_COLUMN_MIN_WIDTH; + +/** + * Returns the column header with field details from the defaultHeaders + */ +export const getColumnHeader = ( + fieldName: string, + defaultHeaders: ColumnHeaderOptions[] +): ColumnHeaderOptions => ({ + columnHeaderType: defaultColumnHeaderType, + id: fieldName, + initialWidth: DEFAULT_COLUMN_MIN_WIDTH, + ...(defaultHeaders.find((c) => c.id === fieldName) ?? {}), +}); diff --git a/x-pack/plugins/security_solution/scripts/endpoint/action_responder/constants.ts b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/constants.ts new file mode 100644 index 0000000000000..23c3292da66e7 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/constants.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const HORIZONTAL_LINE = '-'.repeat(80); + +export const SUPPORTED_TOKENS = `The following tokens can be used in the Action request 'comment' to drive + the type of response that is sent: + Token Description + --------------------------- ------------------------------------------------------- + RESPOND.STATE=SUCCESS Will ensure the Endpoint Action response is success + RESPOND.STATE=FAILURE Will ensure the Endpoint Action response is a failure + RESPOND.FLEET.STATE=SUCCESS Will ensure the Fleet Action response is success + RESPOND.FLEET.STATE=FAILURE Will ensure the Fleet Action response is a failure + +`; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/action_responder/index.ts b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/index.ts new file mode 100644 index 0000000000000..b0683bfbad868 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/index.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { run, RunContext } from '@kbn/dev-cli-runner'; +import { HORIZONTAL_LINE, SUPPORTED_TOKENS } from './constants'; +import { runInAutoMode } from './run_in_auto_mode'; + +export const cli = () => { + run( + async (context: RunContext) => { + context.log.write(` +${HORIZONTAL_LINE} + Endpoint Action Responder +${HORIZONTAL_LINE} +`); + if (context.flags.mode === 'auto') { + return runInAutoMode(context); + } + + context.log.warning(`exiting... Nothing to do. use '--help' to see list of options`); + + context.log.write(` +${HORIZONTAL_LINE} +`); + }, + + { + description: `Respond to pending Endpoint actions. + ${SUPPORTED_TOKENS}`, + flags: { + string: ['mode', 'kibana', 'elastic', 'username', 'password', 'delay'], + boolean: ['asSuperuser'], + default: { + mode: 'auto', + kibana: 'http://localhost:5601', + elastic: 'http://localhost:9200', + username: 'elastic', + password: 'changeme', + asSuperuser: false, + delay: '', + }, + help: ` + --mode The mode for running the tool. (Default: 'auto'). + Value values are: + auto : tool will continue to run and checking for pending + actions periodically. + --username User name to be used for auth against elasticsearch and + kibana (Default: elastic). + **IMPORTANT:** This username's roles MUST have 'superuser'] + and 'kibana_system' roles + --password User name Password (Default: changeme) + --asSuperuser If defined, then a Security super user will be created using the + the credentials defined via 'username' and 'password' options. This + new user will then be used to run this utility. + --delay The delay (in milliseconds) that should be applied before responding + to an action. (Default: 40000 (40s)) + --kibana The url to Kibana (Default: http://localhost:5601) + --elastic The url to Elasticsearch (Default: http:localholst:9200) + `, + }, + } + ); +}; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/action_responder/run_in_auto_mode.ts b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/run_in_auto_mode.ts new file mode 100644 index 0000000000000..a765eba2d062d --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/run_in_auto_mode.ts @@ -0,0 +1,144 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RunContext } from '@kbn/dev-cli-runner'; +import { set } from 'lodash'; +import { SUPPORTED_TOKENS } from './constants'; +import { ActionDetails } from '../../../common/endpoint/types'; +import { createRuntimeServices, RuntimeServices } from '../common/stack_services'; + +import { + fetchEndpointActionList, + sendEndpointActionResponse, + sendFleetActionResponse, + sleep, +} from './utils'; + +const ACTION_RESPONSE_DELAY = 40_000; + +export const runInAutoMode = async ({ + log, + flags: { username, password, asSuperuser, kibana, elastic, delay: _delay }, +}: RunContext) => { + const runtimeServices = await createRuntimeServices({ + log, + password: password as string, + username: username as string, + asSuperuser: asSuperuser as boolean, + elasticsearchUrl: elastic as string, + kibanaUrl: kibana as string, + }); + + log.write(` ${SUPPORTED_TOKENS}`); + + const delay = Number(_delay) || ACTION_RESPONSE_DELAY; + + do { + await checkPendingActionsAndRespond(runtimeServices, { delay }); + await sleep(5_000); + } while (true); +}; + +const checkPendingActionsAndRespond = async ( + { kbnClient, esClient, log }: RuntimeServices, + { delay = ACTION_RESPONSE_DELAY }: { delay?: number } = {} +) => { + let hasMore = true; + let nextPage = 1; + + try { + while (hasMore) { + const { data: actions } = await fetchEndpointActionList(kbnClient, { + page: nextPage++, + pageSize: 100, + }); + + if (actions.length === 0) { + hasMore = false; + } + + for (const action of actions) { + if (action.isCompleted === false) { + if (Date.now() - new Date(action.startedAt).getTime() >= delay) { + log.info( + `[${new Date().toLocaleTimeString()}]: Responding to [${ + action.command + }] action [id: ${action.id}] agent: [${action.agents.join(', ')}]` + ); + + const tokens = parseCommentTokens(getActionComment(action)); + + log.verbose('tokens found in action:', tokens); + + const fleetResponse = await sendFleetActionResponse(esClient, action, { + // If an Endpoint state token was found, then force the Fleet response to `success` + // so that we can actually generate an endpoint response below. + state: tokens.state ? 'success' : tokens.fleet.state, + }); + + // If not a fleet response error, then also sent the Endpoint Response + if (!fleetResponse.error) { + await sendEndpointActionResponse(esClient, action, { state: tokens.state }); + } + } + } + } + } + } catch (e) { + log.error(`${e.message}. Run with '--verbose' option to see more`); + log.verbose(e); + } +}; + +interface CommentTokens { + state: 'success' | 'failure' | undefined; + fleet: { + state: 'success' | 'failure' | undefined; + }; +} + +const parseCommentTokens = (comment: string): CommentTokens => { + const response: CommentTokens = { + state: undefined, + fleet: { + state: undefined, + }, + }; + + if (comment) { + const findTokensRegExp = /(respond\.\S*=\S*)/gi; + let matches; + + while ((matches = findTokensRegExp.exec(comment)) !== null) { + const [key, value] = matches[0] + .toLowerCase() + .split('=') + .map((s) => s.trim()); + + set(response, key.split('.').slice(1), value); + } + } + return response; +}; + +const getActionComment = (action: ActionDetails): string => { + const actionRequest = action.logEntries.find( + (entry) => entry.type === 'fleetAction' || entry.type === 'action' + ); + + if (actionRequest) { + if (actionRequest.type === 'fleetAction') { + return actionRequest.item.data.data.comment ?? ''; + } + + if (actionRequest.type === 'action') { + return actionRequest.item.data.EndpointActions.data.comment ?? ''; + } + } + + return ''; +}; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/action_responder/utils.ts b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/utils.ts new file mode 100644 index 0000000000000..4cdf94436d9e5 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/action_responder/utils.ts @@ -0,0 +1,116 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { KbnClient } from '@kbn/test'; +import { Client } from '@elastic/elasticsearch'; +import { AGENT_ACTIONS_RESULTS_INDEX } from '@kbn/fleet-plugin/common'; +import { FleetActionGenerator } from '../../../common/endpoint/data_generators/fleet_action_generator'; +import { + ENDPOINT_ACTION_RESPONSES_INDEX, + ENDPOINTS_ACTION_LIST_ROUTE, +} from '../../../common/endpoint/constants'; +import { + ActionDetails, + ActionListApiResponse, + EndpointActionData, + EndpointActionResponse, + LogsEndpointActionResponse, +} from '../../../common/endpoint/types'; +import { EndpointActionListRequestQuery } from '../../../common/endpoint/schema/actions'; +import { EndpointActionGenerator } from '../../../common/endpoint/data_generators/endpoint_action_generator'; + +const ES_INDEX_OPTIONS = { headers: { 'X-elastic-product-origin': 'fleet' } }; + +export const fleetActionGenerator = new FleetActionGenerator(); + +export const endpointActionGenerator = new EndpointActionGenerator(); + +export const sleep = (ms: number = 1000) => new Promise((r) => setTimeout(r, ms)); + +export const fetchEndpointActionList = async ( + kbn: KbnClient, + options: EndpointActionListRequestQuery = {} +): Promise => { + return ( + await kbn.request({ + method: 'GET', + path: ENDPOINTS_ACTION_LIST_ROUTE, + query: options, + }) + ).data; +}; + +export const sendFleetActionResponse = async ( + esClient: Client, + action: ActionDetails, + { state }: { state?: 'success' | 'failure' } = {} +): Promise => { + const fleetResponse = fleetActionGenerator.generateResponse({ + action_id: action.id, + agent_id: action.agents[0], + action_response: { + endpoint: { + ack: true, + }, + }, + }); + + // 20% of the time we generate an error + if (state === 'failure' || (!state && fleetActionGenerator.randomFloat() < 0.2)) { + fleetResponse.action_response = {}; + fleetResponse.error = 'Agent failed to deliver message to endpoint due to unknown error'; + } else { + // show it as success (generator currently always generates a `error`, so delete it) + delete fleetResponse.error; + } + + await esClient.index( + { + index: AGENT_ACTIONS_RESULTS_INDEX, + body: fleetResponse, + refresh: 'wait_for', + }, + ES_INDEX_OPTIONS + ); + + return fleetResponse; +}; + +export const sendEndpointActionResponse = async ( + esClient: Client, + action: ActionDetails, + { state }: { state?: 'success' | 'failure' } = {} +): Promise => { + // FIXME:PT Generate command specific responses + + const endpointResponse = endpointActionGenerator.generateResponse({ + agent: { id: action.agents[0] }, + EndpointActions: { + action_id: action.id, + data: { + command: action.command as EndpointActionData['command'], + comment: '', + }, + started_at: action.startedAt, + }, + }); + + // 20% of the time we generate an error + if (state === 'failure' || (state !== 'success' && endpointActionGenerator.randomFloat() < 0.2)) { + endpointResponse.error = { + message: 'Endpoint encountered an error and was unable to apply action to host', + }; + } + + await esClient.index({ + index: ENDPOINT_ACTION_RESPONSES_INDEX, + body: endpointResponse, + refresh: 'wait_for', + }); + + return endpointResponse; +}; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/common/security_user_services.ts b/x-pack/plugins/security_solution/scripts/endpoint/common/security_user_services.ts new file mode 100644 index 0000000000000..52fe4b3d15fe3 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/common/security_user_services.ts @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Client } from '@elastic/elasticsearch'; +import { userInfo } from 'os'; + +export const createSecuritySuperuser = async ( + esClient: Client, + username: string = userInfo().username, + password: string = 'changeme' +): Promise<{ username: string; password: string; created: boolean }> => { + if (!username || !password) { + throw new Error(`username and password require values.`); + } + + const addedUser = await esClient.transport.request>({ + method: 'POST', + path: `_security/user/${username}`, + body: { + password, + roles: ['superuser', 'kibana_system'], + full_name: username, + }, + }); + + return { + created: addedUser.created, + username, + password, + }; +}; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts b/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts new file mode 100644 index 0000000000000..72dbf3ade5e4a --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts @@ -0,0 +1,118 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Client } from '@elastic/elasticsearch'; +import { ToolingLog } from '@kbn/tooling-log'; +import { KbnClient } from '@kbn/test'; +import { createSecuritySuperuser } from './security_user_services'; + +export interface RuntimeServices { + kbnClient: KbnClient; + esClient: Client; + log: ToolingLog; + user: Readonly<{ + username: string; + password: string; + }>; +} + +interface CreateRuntimeServicesOptions { + kibanaUrl: string; + elasticsearchUrl: string; + username: string; + password: string; + log?: ToolingLog; + asSuperuser?: boolean; +} + +export const createRuntimeServices = async ({ + kibanaUrl, + elasticsearchUrl, + username: _username, + password: _password, + log = new ToolingLog(), + asSuperuser = false, +}: CreateRuntimeServicesOptions): Promise => { + let username = _username; + let password = _password; + + if (asSuperuser) { + const superuserResponse = await createSecuritySuperuser( + createEsClient({ + url: elasticsearchUrl, + username, + password, + log, + }) + ); + + ({ username, password } = superuserResponse); + + if (superuserResponse.created) { + log.info(`Kibana user [${username}] was crated with password [${password}]`); + } + } + + return { + kbnClient: createKbnClient({ log, url: kibanaUrl, username, password }), + esClient: createEsClient({ log, url: elasticsearchUrl, username, password }), + log, + user: { + username, + password, + }, + }; +}; + +const buildUrlWithCredentials = (url: string, username: string, password: string): string => { + const newUrl = new URL(url); + + newUrl.username = username; + newUrl.password = password; + + return newUrl.href; +}; + +export const createEsClient = ({ + url, + username, + password, + log, +}: { + url: string; + username: string; + password: string; + log?: ToolingLog; +}): Client => { + const esUrl = buildUrlWithCredentials(url, username, password); + + if (log) { + log.verbose(`Creating Elasticsearch client with URL: ${esUrl}`); + } + + return new Client({ node: esUrl }); +}; + +export const createKbnClient = ({ + url, + username, + password, + log = new ToolingLog(), +}: { + url: string; + username: string; + password: string; + log?: ToolingLog; +}): KbnClient => { + const kbnUrl = buildUrlWithCredentials(url, username, password); + + if (log) { + log.verbose(`Creating Kibana client with URL: ${kbnUrl}`); + } + + return new KbnClient({ log, url: kbnUrl }); +}; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_action_responder.js b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_action_responder.js new file mode 100644 index 0000000000000..3617b8d0d5b32 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_action_responder.js @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +require('../../../../../src/setup_node_env'); +require('./action_responder').cli(); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts index 318e479d7116b..e30b982fc2e9b 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts @@ -8,21 +8,17 @@ import { registerActionDetailsRoutes } from './details'; import { SecuritySolutionPluginRouter } from '../../../types'; import { EndpointAppContext } from '../../types'; -import { registerHostIsolationRoutes } from './isolation'; import { registerActionStatusRoutes } from './status'; import { registerActionAuditLogRoutes } from './audit_log'; import { registerActionListRoutes } from './list'; import { registerResponseActionRoutes } from './response_actions'; -export * from './isolation'; - // wrap route registration export function registerActionRoutes( router: SecuritySolutionPluginRouter, endpointContext: EndpointAppContext ) { - registerHostIsolationRoutes(router, endpointContext); registerActionStatusRoutes(router, endpointContext); registerActionAuditLogRoutes(router, endpointContext); registerActionListRoutes(router, endpointContext); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts deleted file mode 100644 index 85d3fd1f064e2..0000000000000 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts +++ /dev/null @@ -1,568 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -/* eslint-disable @typescript-eslint/no-explicit-any */ - -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { AwaitedProperties } from '@kbn/utility-types'; -import { - KibanaRequest, - KibanaResponseFactory, - RequestHandler, - RouteConfig, -} from '@kbn/core/server'; -import { - elasticsearchServiceMock, - httpServerMock, - httpServiceMock, - loggingSystemMock, - savedObjectsClientMock, -} from '@kbn/core/server/mocks'; -import { parseExperimentalConfigValue } from '../../../../common/experimental_features'; -import { EndpointAppContextService } from '../../endpoint_app_context_services'; -import { - createMockEndpointAppContextServiceSetupContract, - createMockEndpointAppContextServiceStartContract, - createRouteHandlerContext, -} from '../../mocks'; -import { HostIsolationRequestSchema } from '../../../../common/endpoint/schema/actions'; -import { registerHostIsolationRoutes } from './isolation'; -import { createMockConfig } from '../../../lib/detection_engine/routes/__mocks__'; -import { LicenseService } from '../../../../common/license'; -import { Subject } from 'rxjs'; -import { ILicense } from '@kbn/licensing-plugin/common/types'; -import { licenseMock } from '@kbn/licensing-plugin/common/licensing.mock'; -import { License } from '@kbn/licensing-plugin/common/license'; -import { - ISOLATE_HOST_ROUTE, - UNISOLATE_HOST_ROUTE, - metadataTransformPrefix, - ENDPOINT_ACTIONS_INDEX, -} from '../../../../common/endpoint/constants'; -import { - EndpointAction, - HostIsolationRequestBody, - HostIsolationResponse, - HostMetadata, - LogsEndpointAction, -} from '../../../../common/endpoint/types'; -import { EndpointDocGenerator } from '../../../../common/endpoint/generate_data'; -import { legacyMetadataSearchResponseMock } from '../metadata/support/test_support'; -import { AGENT_ACTIONS_INDEX, ElasticsearchAssetType } from '@kbn/fleet-plugin/common'; -import { CasesClientMock } from '@kbn/cases-plugin/server/client/mocks'; -import { EndpointAuthz } from '../../../../common/endpoint/types/authz'; -import type { PackageClient } from '@kbn/fleet-plugin/server'; -import { createMockPackageService } from '@kbn/fleet-plugin/server/mocks'; -import { SecuritySolutionRequestHandlerContextMock } from '../../../lib/detection_engine/routes/__mocks__/request_context'; - -interface CallRouteInterface { - body?: HostIsolationRequestBody; - idxResponse?: any; - searchResponse?: HostMetadata; - mockUser?: any; - license?: License; - authz?: Partial; -} - -const Platinum = licenseMock.createLicense({ license: { type: 'platinum', mode: 'platinum' } }); -const Gold = licenseMock.createLicense({ license: { type: 'gold', mode: 'gold' } }); - -describe('Host Isolation', () => { - describe('schema', () => { - it('should require at least 1 Endpoint ID', () => { - expect(() => { - HostIsolationRequestSchema.body.validate({}); - }).toThrow(); - }); - - it('should accept an Endpoint ID as the only required field', () => { - expect(() => { - HostIsolationRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - }); - }).not.toThrow(); - }); - - it('should accept a comment', () => { - expect(() => { - HostIsolationRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - comment: 'a user comment', - }); - }).not.toThrow(); - }); - - it('should accept alert IDs', () => { - expect(() => { - HostIsolationRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - alert_ids: ['0000000-000-00'], - }); - }).not.toThrow(); - }); - - it('should accept case IDs', () => { - expect(() => { - HostIsolationRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - case_ids: ['000000000-000-000'], - }); - }).not.toThrow(); - }); - }); - - describe('handler', () => { - let endpointAppContextService: EndpointAppContextService; - let mockResponse: jest.Mocked; - let licenseService: LicenseService; - let licenseEmitter: Subject; - - let callRoute: ( - routePrefix: string, - opts: CallRouteInterface, - indexExists?: { endpointDsExists: boolean } - ) => Promise>; - const superUser = { - username: 'superuser', - roles: ['superuser'], - }; - - const docGen = new EndpointDocGenerator(); - - beforeEach(() => { - // instantiate... everything - const mockScopedClient = elasticsearchServiceMock.createScopedClusterClient(); - const mockClusterClient = elasticsearchServiceMock.createClusterClient(); - mockClusterClient.asScoped.mockReturnValue(mockScopedClient); - const routerMock = httpServiceMock.createRouter(); - mockResponse = httpServerMock.createResponseFactory(); - const startContract = createMockEndpointAppContextServiceStartContract(); - endpointAppContextService = new EndpointAppContextService(); - const mockSavedObjectClient = savedObjectsClientMock.create(); - const mockPackageService = createMockPackageService(); - const mockedPackageClient = mockPackageService.asInternalUser as jest.Mocked; - mockedPackageClient.getInstallation.mockResolvedValue({ - installed_kibana: [], - package_assets: [], - es_index_patterns: {}, - name: '', - version: '', - install_status: 'installed', - install_version: '', - install_started_at: '', - install_source: 'registry', - installed_es: [ - { - id: 'logs-endpoint.events.security', - type: ElasticsearchAssetType.indexTemplate, - }, - { - id: `${metadataTransformPrefix}-0.16.0-dev.0`, - type: ElasticsearchAssetType.transform, - }, - ], - keep_policies_up_to_date: false, - }); - - licenseEmitter = new Subject(); - licenseService = new LicenseService(); - licenseService.start(licenseEmitter); - - endpointAppContextService.setup(createMockEndpointAppContextServiceSetupContract()); - endpointAppContextService.start({ - ...startContract, - licenseService, - packageService: mockPackageService, - }); - - // add the host isolation route handlers to routerMock - registerHostIsolationRoutes(routerMock, { - logFactory: loggingSystemMock.create(), - service: endpointAppContextService, - config: () => Promise.resolve(createMockConfig()), - experimentalFeatures: parseExperimentalConfigValue(createMockConfig().enableExperimental), - }); - - // define a convenience function to execute an API call for a given route, body, and mocked response from ES - // it returns the requestContext mock used in the call, to assert internal calls (e.g. the indexed document) - callRoute = async ( - routePrefix: string, - { body, idxResponse, searchResponse, mockUser, license, authz = {} }: CallRouteInterface, - indexExists?: { endpointDsExists: boolean } - ): Promise> => { - const asUser = mockUser ? mockUser : superUser; - (startContract.security.authc.getCurrentUser as jest.Mock).mockImplementationOnce( - () => asUser - ); - - const ctx = createRouteHandlerContext(mockScopedClient, mockSavedObjectClient); - - ctx.securitySolution.endpointAuthz = { - ...ctx.securitySolution.endpointAuthz, - ...authz, - }; - - // mock _index_template - ctx.core.elasticsearch.client.asInternalUser.indices.existsIndexTemplate.mockResponseImplementationOnce( - () => { - if (indexExists) { - return { - body: true, - statusCode: 200, - }; - } - return { - body: false, - statusCode: 404, - }; - } - ); - - const withIdxResp = idxResponse ? idxResponse : { statusCode: 201 }; - ctx.core.elasticsearch.client.asInternalUser.index.mockResponseImplementation( - () => withIdxResp - ); - ctx.core.elasticsearch.client.asCurrentUser.search.mockResponseImplementation(() => { - return { - body: legacyMetadataSearchResponseMock(searchResponse), - }; - }); - - const withLicense = license ? license : Platinum; - licenseEmitter.next(withLicense); - - const mockRequest = httpServerMock.createKibanaRequest({ body }); - const [, routeHandler]: [ - RouteConfig, - RequestHandler - ] = routerMock.post.mock.calls.find(([{ path }]) => path.startsWith(routePrefix))!; - - await routeHandler(ctx, mockRequest, mockResponse); - - return ctx; - }; - }); - - afterEach(() => { - endpointAppContextService.stop(); - licenseService.stop(); - licenseEmitter.complete(); - }); - it('succeeds when an endpoint ID is provided', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); - expect(mockResponse.ok).toBeCalled(); - }); - it('reports elasticsearch errors creating an action', async () => { - const ErrMessage = 'something went wrong?'; - - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - idxResponse: { - statusCode: 500, - body: { - result: ErrMessage, - }, - }, - }); - expect(mockResponse.ok).not.toBeCalled(); - const response = mockResponse.customError.mock.calls[0][0]; - expect(response.statusCode).toEqual(500); - expect((response.body as Error).message).toEqual(ErrMessage); - }); - it('accepts a comment field', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'], comment: 'XYZ' } }); - expect(mockResponse.ok).toBeCalled(); - }); - it('sends the action to the requested agent', async () => { - const metadataResponse = docGen.generateHostMetadata(); - const AgentID = metadataResponse.elastic.agent.id; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['ABC-XYZ-000'] }, - searchResponse: metadataResponse, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.agents).toContain(AgentID); - }); - it('records the user who performed the action to the action record', async () => { - const testU = { username: 'testuser', roles: ['superuser'] }; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - mockUser: testU, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.user_id).toEqual(testU.username); - }); - it('records the comment in the action payload', async () => { - const CommentText = "I am isolating this because it's Friday"; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], comment: CommentText }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.comment).toEqual(CommentText); - }); - it('creates an action and returns its ID', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], comment: 'XYZ' }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - const actionID = actionDoc.action_id; - expect(mockResponse.ok).toBeCalled(); - expect((mockResponse.ok.mock.calls[0][0]?.body as HostIsolationResponse).action).toEqual( - actionID - ); - }); - it('records the timeout in the action payload', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.timeout).toEqual(300); - }); - it('sends the action to the correct agent when endpoint ID is given', async () => { - const doc = docGen.generateHostMetadata(); - const AgentID = doc.elastic.agent.id; - - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - searchResponse: doc, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.agents).toContain(AgentID); - }); - - it('sends the isolate command payload from the isolate route', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.command).toEqual('isolate'); - }); - it('sends the unisolate command payload from the unisolate route', async () => { - const ctx = await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.command).toEqual('unisolate'); - }); - - describe('With endpoint data streams', () => { - it('handles unisolation', async () => { - const ctx = await callRoute( - UNISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - }, - { endpointDsExists: true } - ); - - const indexDoc = ctx.core.elasticsearch.client.asInternalUser.index; - const actionDocs: [ - { index: string; body?: LogsEndpointAction }, - { index: string; body?: EndpointAction } - ] = [ - indexDoc.mock.calls[0][0] as estypes.IndexRequest, - indexDoc.mock.calls[1][0] as estypes.IndexRequest, - ]; - - expect(actionDocs[0].index).toEqual(ENDPOINT_ACTIONS_INDEX); - expect(actionDocs[1].index).toEqual(AGENT_ACTIONS_INDEX); - expect(actionDocs[0].body!.EndpointActions.data.command).toEqual('unisolate'); - expect(actionDocs[1].body!.data.command).toEqual('unisolate'); - }); - - it('handles isolation', async () => { - const ctx = await callRoute( - ISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - }, - { endpointDsExists: true } - ); - const indexDoc = ctx.core.elasticsearch.client.asInternalUser.index; - const actionDocs: [ - { index: string; body?: LogsEndpointAction }, - { index: string; body?: EndpointAction } - ] = [ - indexDoc.mock.calls[0][0] as estypes.IndexRequest, - indexDoc.mock.calls[1][0] as estypes.IndexRequest, - ]; - - expect(actionDocs[0].index).toEqual(ENDPOINT_ACTIONS_INDEX); - expect(actionDocs[1].index).toEqual(AGENT_ACTIONS_INDEX); - expect(actionDocs[0].body!.EndpointActions.data.command).toEqual('isolate'); - expect(actionDocs[1].body!.data.command).toEqual('isolate'); - }); - - it('handles errors', async () => { - const ErrMessage = 'Uh oh!'; - await callRoute( - UNISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - idxResponse: { - statusCode: 500, - body: { - result: ErrMessage, - }, - }, - }, - { endpointDsExists: true } - ); - - expect(mockResponse.ok).not.toBeCalled(); - const response = mockResponse.customError.mock.calls[0][0]; - expect(response.statusCode).toEqual(500); - expect((response.body as Error).message).toEqual(ErrMessage); - }); - }); - - describe('License Level', () => { - it('allows platinum license levels to isolate hosts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - license: Platinum, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('prohibits isolating hosts if no authz for it', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canIsolateHost: false }, - license: Gold, - }); - - expect(mockResponse.forbidden).toBeCalled(); - }); - - it('allows any license level to unisolate', async () => { - licenseEmitter.next(Gold); - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - license: Gold, - }); - expect(mockResponse.ok).toBeCalled(); - }); - }); - - describe('User Authorization Level', () => { - it('allows user to perform isolation when canIsolateHost is true', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('allows user to perform unisolation when canUnIsolateHost is true', async () => { - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('prohibits user from performing isolation if canIsolateHost is false', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canIsolateHost: false }, - }); - expect(mockResponse.forbidden).toBeCalled(); - }); - - it('prohibits user from performing un-isolation if canUnIsolateHost is false', async () => { - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canUnIsolateHost: false }, - }); - expect(mockResponse.forbidden).toBeCalled(); - }); - }); - - describe('Cases', () => { - let casesClient: CasesClientMock; - - const getCaseIdsFromAttachmentAddService = () => { - return casesClient.attachments.add.mock.calls.map(([addArgs]) => addArgs.caseId); - }; - - beforeEach(async () => { - casesClient = (await endpointAppContextService.getCasesClient( - {} as KibanaRequest - )) as CasesClientMock; - - let counter = 1; - casesClient.cases.getCasesByAlertID.mockImplementation(async () => { - return [ - { - id: `case-${counter++}`, - title: 'case', - }, - ]; - }); - }); - - it('logs a comment to the provided cases', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], case_ids: ['one', 'two'] }, - }); - - expect(casesClient.attachments.add).toHaveBeenCalledTimes(2); - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['one', 'two']) - ); - }); - - it('logs a comment to any cases associated with the given alerts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], alert_ids: ['one', 'two'] }, - }); - - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['case-1', 'case-2']) - ); - }); - - it('logs a comment to any cases provided on input along with cases associated with the given alerts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - // 'case-1` provided on `case_ids` should be dedupped - body: { - endpoint_ids: ['XYZ'], - case_ids: ['ONE', 'TWO', 'case-1'], - alert_ids: ['one', 'two'], - }, - }); - - expect(casesClient.attachments.add).toHaveBeenCalledTimes(4); - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['ONE', 'TWO', 'case-1', 'case-2']) - ); - }); - }); - }); -}); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts deleted file mode 100644 index c640f56efb512..0000000000000 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts +++ /dev/null @@ -1,294 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import moment from 'moment'; -import { RequestHandler, Logger } from '@kbn/core/server'; -import uuid from 'uuid'; -import { TypeOf } from '@kbn/config-schema'; -import { CommentType } from '@kbn/cases-plugin/common'; -import { CasesByAlertId } from '@kbn/cases-plugin/common/api/cases/case'; -import { AGENT_ACTIONS_INDEX } from '@kbn/fleet-plugin/common'; -import { HostIsolationRequestSchema } from '../../../../common/endpoint/schema/actions'; -import { - ENDPOINT_ACTIONS_DS, - ENDPOINT_ACTION_RESPONSES_DS, - ISOLATE_HOST_ROUTE, - UNISOLATE_HOST_ROUTE, - failedFleetActionErrorCode, -} from '../../../../common/endpoint/constants'; -import { - EndpointAction, - HostMetadata, - LogsEndpointAction, - LogsEndpointActionResponse, -} from '../../../../common/endpoint/types'; -import { - SecuritySolutionPluginRouter, - SecuritySolutionRequestHandlerContext, -} from '../../../types'; -import { getMetadataForEndpoints } from '../../services'; -import { EndpointAppContext } from '../../types'; -import { APP_ID } from '../../../../common/constants'; -import { doLogsEndpointActionDsExists } from '../../utils'; -import { withEndpointAuthz } from '../with_endpoint_authz'; - -/** - * Registers the Host-(un-)isolation routes - */ -export function registerHostIsolationRoutes( - router: SecuritySolutionPluginRouter, - endpointContext: EndpointAppContext -) { - const logger = endpointContext.logFactory.get('hostIsolation'); - - // perform isolation - router.post( - { - path: ISOLATE_HOST_ROUTE, - validate: HostIsolationRequestSchema, - options: { authRequired: true, tags: ['access:securitySolution'] }, - }, - withEndpointAuthz( - { all: ['canIsolateHost'] }, - logger, - isolationRequestHandler(endpointContext, true) - ) - ); - - // perform UN-isolate - router.post( - { - path: UNISOLATE_HOST_ROUTE, - validate: HostIsolationRequestSchema, - options: { authRequired: true, tags: ['access:securitySolution'] }, - }, - withEndpointAuthz( - { all: ['canUnIsolateHost'] }, - logger, - isolationRequestHandler(endpointContext, false) - ) - ); -} - -const createFailedActionResponseEntry = async ({ - context, - doc, - logger, -}: { - context: SecuritySolutionRequestHandlerContext; - doc: LogsEndpointActionResponse; - logger: Logger; -}): Promise => { - // 8.0+ requires internal user to write to system indices - const esClient = (await context.core).elasticsearch.client.asInternalUser; - try { - await esClient.index({ - index: `${ENDPOINT_ACTION_RESPONSES_DS}-default`, - body: { - ...doc, - error: { - code: failedFleetActionErrorCode, - message: 'Failed to deliver action request to fleet', - }, - }, - }); - } catch (e) { - logger.error(e); - } -}; - -export const isolationRequestHandler = function ( - endpointContext: EndpointAppContext, - isolate: boolean -): RequestHandler< - unknown, - unknown, - TypeOf, - SecuritySolutionRequestHandlerContext -> { - return async (context, req, res) => { - endpointContext.service.getFeatureUsageService().notifyUsage('HOST_ISOLATION'); - const user = endpointContext.service.security?.authc.getCurrentUser(req); - - // fetch the Agent IDs to send the commands to - const endpointIDs = [...new Set(req.body.endpoint_ids)]; // dedupe - const endpointData = await getMetadataForEndpoints(endpointIDs, context); - - const casesClient = await endpointContext.service.getCasesClient(req); - - // convert any alert IDs into cases - let caseIDs: string[] = req.body.case_ids?.slice() || []; - if (req.body.alert_ids && req.body.alert_ids.length > 0) { - const newIDs: string[][] = await Promise.all( - req.body.alert_ids.map(async (a: string) => { - const cases: CasesByAlertId = await casesClient.cases.getCasesByAlertID({ - alertID: a, - options: { owner: APP_ID }, - }); - return cases.map((caseInfo): string => { - return caseInfo.id; - }); - }) - ); - caseIDs = caseIDs.concat(...newIDs); - } - caseIDs = [...new Set(caseIDs)]; - - // create an Action ID and dispatch it to ES & Fleet Server - const actionID = uuid.v4(); - - let fleetActionIndexResult; - let logsEndpointActionsResult; - - const agents = endpointData.map((endpoint: HostMetadata) => endpoint.elastic.agent.id); - const doc = { - '@timestamp': moment().toISOString(), - agent: { - id: agents, - }, - EndpointActions: { - action_id: actionID, - expiration: moment().add(2, 'weeks').toISOString(), - type: 'INPUT_ACTION', - input_type: 'endpoint', - data: { - command: isolate ? 'isolate' : 'unisolate', - comment: req.body.comment ?? undefined, - }, - } as Omit, - user: { - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - id: user!.username, - }, - }; - - // if .logs-endpoint.actions data stream exists - // try to create action request record in .logs-endpoint.actions DS as the current user - // (from >= v7.16, use this check to ensure the current user has privileges to write to the new index) - // and allow only users with superuser privileges to write to fleet indices - const logger = endpointContext.logFactory.get('host-isolation'); - const doesLogsEndpointActionsDsExist = await doLogsEndpointActionDsExists({ - context, - logger, - dataStreamName: ENDPOINT_ACTIONS_DS, - }); - - // 8.0+ requires internal user to write to system indices - const esClient = (await context.core).elasticsearch.client.asInternalUser; - - // if the new endpoint indices/data streams exists - // write the action request to the new endpoint index - if (doesLogsEndpointActionsDsExist) { - try { - logsEndpointActionsResult = await esClient.index( - { - index: `${ENDPOINT_ACTIONS_DS}-default`, - body: { - ...doc, - }, - refresh: 'wait_for', - }, - { meta: true } - ); - if (logsEndpointActionsResult.statusCode !== 201) { - return res.customError({ - statusCode: 500, - body: { - message: logsEndpointActionsResult.body.result, - }, - }); - } - } catch (e) { - return res.customError({ - statusCode: 500, - body: { message: e }, - }); - } - } - - // write actions to .fleet-actions index - try { - fleetActionIndexResult = await esClient.index( - { - index: AGENT_ACTIONS_INDEX, - body: { - ...doc.EndpointActions, - '@timestamp': doc['@timestamp'], - agents, - timeout: 300, // 5 minutes - user_id: doc.user.id, - }, - refresh: 'wait_for', - }, - { meta: true } - ); - - if (fleetActionIndexResult.statusCode !== 201) { - return res.customError({ - statusCode: 500, - body: { - message: fleetActionIndexResult.body.result, - }, - }); - } - } catch (e) { - // create entry in .logs-endpoint.action.responses-default data stream - // when writing to .fleet-actions fails - if (doesLogsEndpointActionsDsExist) { - await createFailedActionResponseEntry({ - context, - doc: { - '@timestamp': moment().toISOString(), - agent: doc.agent, - EndpointActions: { - action_id: doc.EndpointActions.action_id, - completed_at: moment().toISOString(), - started_at: moment().toISOString(), - data: doc.EndpointActions.data, - }, - }, - logger, - }); - } - return res.customError({ - statusCode: 500, - body: { message: e }, - }); - } - - // Update all cases with a comment - if (caseIDs.length > 0) { - const targets = endpointData.map((endpt: HostMetadata) => ({ - hostname: endpt.host.hostname, - endpointId: endpt.agent.id, - })); - - await Promise.all( - caseIDs.map((caseId) => - casesClient.attachments.add({ - caseId, - comment: { - type: CommentType.actions, - comment: req.body.comment || '', - actions: { - targets, - type: isolate ? 'isolate' : 'unisolate', - }, - owner: APP_ID, - }, - }) - ) - ); - } - - return res.ok({ - body: { - action: actionID, - }, - }); - }; -}; diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts index 3a91ee35269be..c91d000f8341c 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts @@ -35,11 +35,14 @@ import { parseExperimentalConfigValue } from '../../../../common/experimental_fe import { LicenseService } from '../../../../common/license'; import { ISOLATE_HOST_ROUTE_V2, - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, metadataTransformPrefix, ENDPOINT_ACTIONS_INDEX, KILL_PROCESS_ROUTE, SUSPEND_PROCESS_ROUTE, + GET_RUNNING_PROCESSES_ROUTE, + ISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE, } from '../../../../common/endpoint/constants'; import { ActionDetails, @@ -220,6 +223,22 @@ describe('Response actions', () => { getActionDetailsByIdSpy.mockClear(); }); + it('correctly redirects legacy isolate to new route', async () => { + await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); + expect(mockResponse.custom).toBeCalled(); + const response = mockResponse.custom.mock.calls[0][0]; + expect(response.statusCode).toEqual(308); + expect(response.headers?.location).toEqual(ISOLATE_HOST_ROUTE_V2); + }); + + it('correctly redirects legacy release to new route', async () => { + await callRoute(UNISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); + expect(mockResponse.custom).toBeCalled(); + const response = mockResponse.custom.mock.calls[0][0]; + expect(response.statusCode).toEqual(308); + expect(response.headers?.location).toEqual(UNISOLATE_HOST_ROUTE_V2); + }); + it('succeeds when an endpoint ID is provided', async () => { await callRoute(ISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] } }); expect(mockResponse.ok).toBeCalled(); @@ -349,7 +368,7 @@ describe('Response actions', () => { }); it('sends the unisolate command payload from the unisolate route', async () => { - const ctx = await callRoute(RELEASE_HOST_ROUTE, { + const ctx = await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }); const actionDoc: EndpointAction = ( @@ -381,10 +400,21 @@ describe('Response actions', () => { expect(actionDoc.data.command).toEqual('suspend-process'); }); + it('sends the running-processes command payload from the running processes route', async () => { + const ctx = await callRoute(GET_RUNNING_PROCESSES_ROUTE, { + body: { endpoint_ids: ['XYZ'] }, + }); + const actionDoc: EndpointAction = ( + ctx.core.elasticsearch.client.asInternalUser.index.mock + .calls[0][0] as estypes.IndexRequest + ).body!; + expect(actionDoc.data.command).toEqual('running-processes'); + }); + describe('With endpoint data streams', () => { it('handles unisolation', async () => { const ctx = await callRoute( - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }, @@ -495,10 +525,37 @@ describe('Response actions', () => { expect(responseBody.action).toBeUndefined(); }); + it('handles running-processes', async () => { + const ctx = await callRoute( + GET_RUNNING_PROCESSES_ROUTE, + { + body: { endpoint_ids: ['XYZ'] }, + }, + { endpointDsExists: true } + ); + const indexDoc = ctx.core.elasticsearch.client.asInternalUser.index; + const actionDocs: [ + { index: string; body?: LogsEndpointAction }, + { index: string; body?: EndpointAction } + ] = [ + indexDoc.mock.calls[0][0] as estypes.IndexRequest, + indexDoc.mock.calls[1][0] as estypes.IndexRequest, + ]; + + expect(actionDocs[0].index).toEqual(ENDPOINT_ACTIONS_INDEX); + expect(actionDocs[1].index).toEqual(AGENT_ACTIONS_INDEX); + expect(actionDocs[0].body!.EndpointActions.data.command).toEqual('running-processes'); + expect(actionDocs[1].body!.data.command).toEqual('running-processes'); + + expect(mockResponse.ok).toBeCalled(); + const responseBody = mockResponse.ok.mock.calls[0][0]?.body as ResponseActionApiResponse; + expect(responseBody.action).toBeUndefined(); + }); + it('handles errors', async () => { const ErrMessage = 'Uh oh!'; await callRoute( - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, idxResponse: { @@ -539,7 +596,7 @@ describe('Response actions', () => { it('allows any license level to unisolate', async () => { licenseEmitter.next(Gold); - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, license: Gold, }); @@ -556,7 +613,7 @@ describe('Response actions', () => { }); it('allows user to perform unisolation when canUnIsolateHost is true', async () => { - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }); expect(mockResponse.ok).toBeCalled(); @@ -571,7 +628,7 @@ describe('Response actions', () => { }); it('prohibits user from performing un-isolation if canUnIsolateHost is false', async () => { - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, authz: { canUnIsolateHost: false }, }); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts index 5f7ad42127f7c..5d024488d4958 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts @@ -15,19 +15,22 @@ import { AGENT_ACTIONS_INDEX } from '@kbn/fleet-plugin/common'; import { CommentType } from '@kbn/cases-plugin/common'; import { - HostIsolationRequestSchema, + NoParametersRequestSchema, KillOrSuspendProcessRequestSchema, ResponseActionBodySchema, } from '../../../../common/endpoint/schema/actions'; import { APP_ID } from '../../../../common/constants'; import { ISOLATE_HOST_ROUTE_V2, - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, ENDPOINT_ACTIONS_DS, ENDPOINT_ACTION_RESPONSES_DS, failedFleetActionErrorCode, KILL_PROCESS_ROUTE, SUSPEND_PROCESS_ROUTE, + GET_RUNNING_PROCESSES_ROUTE, + ISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE, } from '../../../../common/endpoint/constants'; import type { EndpointAction, @@ -55,10 +58,38 @@ export function registerResponseActionRoutes( ) { const logger = endpointContext.logFactory.get('hostIsolation'); + /** + * @deprecated use ISOLATE_HOST_ROUTE_V2 instead + */ + router.post( + { + path: ISOLATE_HOST_ROUTE, + validate: NoParametersRequestSchema, + options: { authRequired: true, tags: ['access:securitySolution'] }, + }, + withEndpointAuthz({ all: ['canIsolateHost'] }, logger, redirectHandler(ISOLATE_HOST_ROUTE_V2)) + ); + + /** + * @deprecated use RELEASE_HOST_ROUTE instead + */ + router.post( + { + path: UNISOLATE_HOST_ROUTE, + validate: NoParametersRequestSchema, + options: { authRequired: true, tags: ['access:securitySolution'] }, + }, + withEndpointAuthz( + { all: ['canUnIsolateHost'] }, + logger, + redirectHandler(UNISOLATE_HOST_ROUTE_V2) + ) + ); + router.post( { path: ISOLATE_HOST_ROUTE_V2, - validate: HostIsolationRequestSchema, + validate: NoParametersRequestSchema, options: { authRequired: true, tags: ['access:securitySolution'] }, }, withEndpointAuthz( @@ -70,8 +101,8 @@ export function registerResponseActionRoutes( router.post( { - path: RELEASE_HOST_ROUTE, - validate: HostIsolationRequestSchema, + path: UNISOLATE_HOST_ROUTE_V2, + validate: NoParametersRequestSchema, options: { authRequired: true, tags: ['access:securitySolution'] }, }, withEndpointAuthz( @@ -112,6 +143,19 @@ export function registerResponseActionRoutes( ) ) ); + + router.post( + { + path: GET_RUNNING_PROCESSES_ROUTE, + validate: NoParametersRequestSchema, + options: { authRequired: true, tags: ['access:securitySolution'] }, + }, + withEndpointAuthz( + { all: ['canGetRunningProcesses'] }, + logger, + responseActionRequestHandler(endpointContext, 'running-processes') + ) + ); } const commandToFeatureKeyMap = new Map([ @@ -119,6 +163,7 @@ const commandToFeatureKeyMap = new Map([ ['unisolate', 'HOST_ISOLATION'], ['kill-process', 'KILL_PROCESS'], ['suspend-process', 'SUSPEND_PROCESS'], + ['running-processes', 'RUNNING_PROCESSES'], ]); const returnActionIdCommands: ResponseActions[] = ['isolate', 'unisolate']; @@ -349,3 +394,19 @@ const createFailedActionResponseEntry = async ({ logger.error(e); } }; + +function redirectHandler( + location: string +): RequestHandler< + unknown, + unknown, + TypeOf, + SecuritySolutionRequestHandlerContext +> { + return async (_context, _req, res) => { + return res.custom({ + statusCode: 308, + headers: { location }, + }); + }; +} diff --git a/x-pack/plugins/security_solution/server/endpoint/services/feature_usage/service.ts b/x-pack/plugins/security_solution/server/endpoint/services/feature_usage/service.ts index 4171bb803fe65..53cb1b8ec2098 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/feature_usage/service.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/feature_usage/service.ts @@ -20,6 +20,7 @@ const FEATURES = { BEHAVIOR_PROTECTION: 'Behavior protection', KILL_PROCESS: 'Kill process', SUSPEND_PROCESS: 'Suspend process', + RUNNING_PROCESSES: 'Get running processes', } as const; export type FeatureKeys = keyof typeof FEATURES; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/get_installed_integrations_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/get_installed_integrations_route.ts index 5809af1b1642f..7dbc67e6125b0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/get_installed_integrations_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/get_installed_integrations_route.ts @@ -5,18 +5,25 @@ * 2.0. */ +import { Logger } from '@kbn/core/server'; import { transformError } from '@kbn/securitysolution-es-utils'; - +import { initPromisePool } from '../../../../../utils/promise_pool'; +import { buildSiemResponse } from '../../utils'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; + import { DETECTION_ENGINE_INSTALLED_INTEGRATIONS_URL } from '../../../../../../common/constants'; import { GetInstalledIntegrationsResponse } from '../../../../../../common/detection_engine/schemas/response/get_installed_integrations_response_schema'; -import { buildSiemResponse } from '../../utils'; import { createInstalledIntegrationSet } from './installed_integration_set'; +const MAX_CONCURRENT_REQUESTS_TO_PACKAGE_REGISTRY = 5; + /** * Returns an array of installed Fleet integrations and their packages. */ -export const getInstalledIntegrationsRoute = (router: SecuritySolutionPluginRouter) => { +export const getInstalledIntegrationsRoute = ( + router: SecuritySolutionPluginRouter, + logger: Logger +) => { router.get( { path: DETECTION_ENGINE_INSTALLED_INTEGRATIONS_URL, @@ -39,17 +46,40 @@ export const getInstalledIntegrationsRoute = (router: SecuritySolutionPluginRout set.addPackagePolicy(policy); }); - const registryPackages = await Promise.all( - set.getPackages().map((packageInfo) => { - return fleet.packages.getRegistryPackage( + const registryPackages = await initPromisePool({ + concurrency: MAX_CONCURRENT_REQUESTS_TO_PACKAGE_REGISTRY, + items: set.getPackages(), + executor: async (packageInfo) => { + const registryPackage = await fleet.packages.getRegistryPackage( packageInfo.package_name, packageInfo.package_version ); - }) - ); + return registryPackage; + }, + }); + + if (registryPackages.errors.length > 0) { + const errors = registryPackages.errors.map(({ error, item }) => { + return { + error, + packageId: `${item.package_name}@${item.package_version}`, + }; + }); + + const packages = errors.map((e) => e.packageId).join(', '); + logger.error( + `Unable to retrieve installed integrations. Error fetching packages from registry: ${packages}.` + ); + + errors.forEach(({ error, packageId }) => { + const logMessage = `Error fetching package info from registry for ${packageId}`; + const logReason = error instanceof Error ? error.message : String(error); + logger.debug(`${logMessage}. ${logReason}`); + }); + } - registryPackages.forEach((registryPackage) => { - set.addRegistryPackage(registryPackage.packageInfo); + registryPackages.results.forEach(({ result }) => { + set.addRegistryPackage(result.packageInfo); }); const installedIntegrations = set.getIntegrations(); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/installed_integration_set.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/installed_integration_set.ts index 5ea546359c972..092435a07f360 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/installed_integration_set.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet/get_installed_integrations/installed_integration_set.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { flatten } from 'lodash'; +import { capitalize, flatten } from 'lodash'; import { PackagePolicy, RegistryPackage } from '@kbn/fleet-plugin/common'; import { InstalledIntegration, @@ -35,7 +35,7 @@ export const createInstalledIntegrationSet = (): IInstalledIntegrationSet => { const addPackagePolicy = (policy: PackagePolicy): void => { const packageInfo = getPackageInfoFromPolicy(policy); - const integrationsInfo = getIntegrationsInfoFromPolicy(policy); + const integrationsInfo = getIntegrationsInfoFromPolicy(policy, packageInfo); const packageKey = `${packageInfo.package_name}:${packageInfo.package_version}`; const existingPackageInfo = packageMap.get(packageKey); @@ -121,11 +121,16 @@ const getPackageInfoFromPolicy = (policy: PackagePolicy): InstalledPackageBasicI }; }; -const getIntegrationsInfoFromPolicy = (policy: PackagePolicy): InstalledIntegrationBasicInfo[] => { +const getIntegrationsInfoFromPolicy = ( + policy: PackagePolicy, + packageInfo: InstalledPackageBasicInfo +): InstalledIntegrationBasicInfo[] => { return policy.inputs.map((input) => { + const integrationName = normalizeString(input.policy_template); // e.g. 'cloudtrail' + const integrationTitle = `${packageInfo.package_title} ${capitalize(integrationName)}`; // e.g. 'AWS Cloudtrail' return { - integration_name: normalizeString(input.policy_template), - integration_title: '', // this gets initialized later in addRegistryPackage() + integration_name: integrationName, + integration_title: integrationTitle, // title gets re-initialized later in addRegistryPackage() is_enabled: input.enabled, }; }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/discovery_remote_system_discovery_commands_windows.json b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/discovery_remote_system_discovery_commands_windows.json index 3b004c28fe846..d31c55737fb03 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/discovery_remote_system_discovery_commands_windows.json +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/discovery_remote_system_discovery_commands_windows.json @@ -13,7 +13,7 @@ "license": "Elastic License v2", "name": "Remote System Discovery Commands", "note": "## Triage and analysis\n\n### Investigating Remote System Discovery Commands\n\nAfter successfully compromising an environment, attackers may try to gain situational awareness to plan their next steps.\nThis can happen by running commands to enumerate network resources, users, connections, files, and installed security\nsoftware.\n\nThis rule looks for the execution of the `arp` or `nbstat` utilities to enumerate remote systems in the environment,\nwhich is useful for attackers to identify lateral movement targets.\n\n#### Possible investigation steps\n\n- Investigate the process execution chain (parent process tree) for unknown processes. Examine their executable files\nfor prevalence, whether they are located in expected locations, and if they are signed with valid digital signatures.\n- Identify the user account that performed the action and whether it should perform this kind of action.\n- Investigate other alerts associated with the user/host during the past 48 hours.\n- Investigate abnormal behaviors observed using the account, such as commands executed, files created or modified, and\nnetwork connections.\n\n### False positive analysis\n\n- Discovery activities are not inherently malicious if they occur in isolation. As long as the analyst did not identify\nsuspicious activity related to the user or host, such alerts can be dismissed.\n\n### Response and remediation\n\n- Initiate the incident response process based on the outcome of the triage.\n- Isolate the involved hosts to prevent further post-compromise behavior.\n- Investigate credential exposure on systems compromised or used by the attacker to ensure all compromised accounts are\nidentified. Reset passwords for these accounts and other potentially compromised credentials, such as email, business\nsystems, and web services.\n- Run a full antimalware scan. This may reveal additional artifacts left in the system, persistence mechanisms, and\nmalware components.\n- Determine the initial vector abused by the attacker and take action to prevent reinfection via the same vector.\n- Using the incident response data, update logging and audit policies to improve the mean time to detect (MTTD) and the\nmean time to respond (MTTR).\n\n## Config\n\nIf enabling an EQL rule on a non-elastic-agent index (such as beats) for versions <8.2, events will not define `event.ingested` and default fallback for EQL rules was not added until 8.2, so you will need to add a custom pipeline to populate `event.ingested` to @timestamp for this rule to work.\n", - "query": "process where event.type in (\"start\", \"process_started\") and\n (process.name : \"nbtstat.exe\" and process.args : (\"-n\", \"-s\")) or\n (process.name : \"arp.exe\" and process.args : \"-a\")\n", + "query": "process where event.type in (\"start\", \"process_started\") and\n ((process.name : \"nbtstat.exe\" and process.args : (\"-n\", \"-s\")) or\n (process.name : \"arp.exe\" and process.args : \"-a\"))\n", "risk_score": 21, "rule_id": "0635c542-1b96-4335-9b47-126582d2c19a", "severity": "low", diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/execution_user_exec_to_pod.json b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/execution_user_exec_to_pod.json new file mode 100644 index 0000000000000..72c4a8399a0de --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/execution_user_exec_to_pod.json @@ -0,0 +1,50 @@ +{ + "author": [ + "Elastic" + ], + "description": "This rule detects a user attempt to establish a shell session into a pod using the 'exec' command. Using the 'exec' command in a pod allows a user to establish a temporary shell session and execute any process/commands in the pod. An adversary may call bash to gain a persistent interactive shell which will allow access to any data the pod has permissions to, including secrets.", + "false_positives": [ + "An administrator may need to exec into a pod for a legitimate reason like debugging purposes. Containers built from Linux and Windows OS images, tend to include debugging utilities. In this case, an admin may choose to run commands inside a specific container with kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN}. For example, the following command can be used to look at logs from a running Cassandra pod: kubectl exec cassandra --cat /var/log/cassandra/system.log . Additionally, the -i and -t arguments might be used to run a shell connected to the terminal: kubectl exec -i -t cassandra -- sh" + ], + "index": [ + "logs-kubernetes.*" + ], + "language": "kuery", + "license": "Elastic License v2", + "name": "Kubernetes User Exec into Pod", + "note": "## Config\n\nThe Kubernetes Fleet integration with Audit Logs enabled or similarly structured data is required to be compatible with this rule.", + "query": "event.dataset:\"kubernetes.audit_logs\" \n and kubernetes.audit.objectRef.resource:\"pods\" \n and kubernetes.audit.objectRef.subresource:\"exec\"\n", + "references": [ + "https://kubernetes.io/docs/tasks/debug/debug-application/debug-running-pod/", + "https://kubernetes.io/docs/tasks/debug/debug-application/get-shell-running-container/" + ], + "risk_score": 47, + "rule_id": "14de811c-d60f-11ec-9fd7-f661ea17fbce", + "severity": "medium", + "tags": [ + "Elastic", + "Kubernetes", + "Continuous Monitoring", + "Execution" + ], + "threat": [ + { + "framework": "MITRE ATT&CK", + "tactic": { + "id": "TA0002", + "name": "Execution", + "reference": "https://attack.mitre.org/tactics/TA0002/" + }, + "technique": [ + { + "id": "T1609", + "name": "Container Administration Command", + "reference": "https://attack.mitre.org/techniques/T1609/" + } + ] + } + ], + "timestamp_override": "event.ingested", + "type": "query", + "version": 1 +} diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/index.ts index e579cb36edf0d..a02e40e55dbeb 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/index.ts @@ -86,14 +86,14 @@ import rule73 from './linux_iodine_activity.json'; import rule74 from './linux_netcat_network_connection.json'; import rule75 from './linux_nping_activity.json'; import rule76 from './linux_process_started_in_temp_directory.json'; -import rule77 from './linux_strace_activity.json'; -import rule78 from './persistence_adobe_hijack_persistence.json'; -import rule79 from './persistence_local_scheduled_task_creation.json'; -import rule80 from './persistence_priv_escalation_via_accessibility_features.json'; -import rule81 from './persistence_shell_activity_by_web_server.json'; -import rule82 from './persistence_system_shells_via_services.json'; -import rule83 from './persistence_user_account_creation.json'; -import rule84 from './persistence_via_application_shimming.json'; +import rule77 from './persistence_adobe_hijack_persistence.json'; +import rule78 from './persistence_local_scheduled_task_creation.json'; +import rule79 from './persistence_priv_escalation_via_accessibility_features.json'; +import rule80 from './persistence_shell_activity_by_web_server.json'; +import rule81 from './persistence_system_shells_via_services.json'; +import rule82 from './persistence_user_account_creation.json'; +import rule83 from './persistence_via_application_shimming.json'; +import rule84 from './privilege_escalation_linux_strace_activity.json'; import rule85 from './privilege_escalation_unusual_parentchild_relationship.json'; import rule86 from './impact_modification_of_boot_config.json'; import rule87 from './privilege_escalation_uac_bypass_event_viewer.json'; @@ -680,8 +680,9 @@ import rule667 from './execution_abnormal_process_id_file_created.json'; import rule668 from './execution_process_started_from_process_id_file.json'; import rule669 from './privilege_escalation_suspicious_dnshostname_update.json'; import rule670 from './command_and_control_connection_attempt_by_non_ssh_root_session.json'; -import rule671 from './defense_evasion_elastic_agent_service_terminated.json'; -import rule672 from './defense_evasion_proxy_execution_via_msdt.json'; +import rule671 from './execution_user_exec_to_pod.json'; +import rule672 from './defense_evasion_elastic_agent_service_terminated.json'; +import rule673 from './defense_evasion_proxy_execution_via_msdt.json'; export const rawRules = [ rule1, @@ -1356,4 +1357,5 @@ export const rawRules = [ rule670, rule671, rule672, + rule673, ]; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/linux_strace_activity.json b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/linux_strace_activity.json deleted file mode 100644 index 210a71ced9222..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/linux_strace_activity.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "author": [ - "Elastic" - ], - "description": "Strace runs in a privileged context and can be used to escape restrictive environments by instantiating a shell in order to elevate privileges or move laterally.", - "false_positives": [ - "Strace is a dual-use tool that can be used for benign or malicious activity. Some normal use of this command may originate from developers or SREs engaged in debugging or system call tracing." - ], - "from": "now-9m", - "index": [ - "auditbeat-*", - "logs-endpoint.events.*" - ], - "language": "kuery", - "license": "Elastic License v2", - "name": "Strace Process Activity", - "query": "event.category:process and event.type:(start or process_started) and process.name:strace\n", - "references": [ - "https://en.wikipedia.org/wiki/Strace" - ], - "risk_score": 21, - "rule_id": "d6450d4e-81c6-46a3-bd94-079886318ed5", - "severity": "low", - "tags": [ - "Elastic", - "Host", - "Linux", - "Threat Detection" - ], - "timestamp_override": "event.ingested", - "type": "query", - "version": 7 -} diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/privilege_escalation_linux_strace_activity.json b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/privilege_escalation_linux_strace_activity.json new file mode 100644 index 0000000000000..a649bcd3ac487 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rules/prepackaged_rules/privilege_escalation_linux_strace_activity.json @@ -0,0 +1,51 @@ +{ + "author": [ + "Elastic" + ], + "description": "Strace is a useful diagnostic, instructional, and debugging tool. This rule identifies a privileged context execution of strace which can be used to escape restrictive environments by instantiating a shell in order to elevate privileges or move laterally.", + "false_positives": [ + "Strace is a dual-use tool that can be used for benign or malicious activity. Some normal use of this command may originate from developers or SREs engaged in debugging or system call tracing." + ], + "from": "now-9m", + "index": [ + "auditbeat-*", + "logs-endpoint.events.*" + ], + "language": "kuery", + "license": "Elastic License v2", + "name": "Strace Process Activity", + "query": "event.category:process and event.type:(start or process_started) and process.name:strace\n", + "references": [ + "https://en.wikipedia.org/wiki/Strace" + ], + "risk_score": 21, + "rule_id": "d6450d4e-81c6-46a3-bd94-079886318ed5", + "severity": "low", + "tags": [ + "Elastic", + "Host", + "Linux", + "Threat Detection", + "Privilege Escalation" + ], + "threat": [ + { + "framework": "MITRE ATT&CK", + "tactic": { + "id": "TA0004", + "name": "Privilege Escalation", + "reference": "https://attack.mitre.org/tactics/TA0004/" + }, + "technique": [ + { + "id": "T1068", + "name": "Exploitation for Privilege Escalation", + "reference": "https://attack.mitre.org/techniques/T1068/" + } + ] + } + ], + "timestamp_override": "event.ingested", + "type": "query", + "version": 8 +} diff --git a/x-pack/plugins/security_solution/server/lib/telemetry/receiver.ts b/x-pack/plugins/security_solution/server/lib/telemetry/receiver.ts index 8712a51b15069..bd98cef5187d4 100644 --- a/x-pack/plugins/security_solution/server/lib/telemetry/receiver.ts +++ b/x-pack/plugins/security_solution/server/lib/telemetry/receiver.ts @@ -667,7 +667,7 @@ export class TelemetryReceiver implements ITelemetryReceiver { expand_wildcards: ['open' as const, 'hidden' as const], index: `${this.alertsIndex}*`, ignore_unavailable: true, - size: 100, + size: 30, body: { query: { bool: { diff --git a/x-pack/plugins/security_solution/server/routes/index.ts b/x-pack/plugins/security_solution/server/routes/index.ts index d64cbd397ecfa..04bc2e1e3988a 100644 --- a/x-pack/plugins/security_solution/server/routes/index.ts +++ b/x-pack/plugins/security_solution/server/routes/index.ts @@ -119,7 +119,7 @@ export const initRoutes = ( getRuleExecutionEventsRoute(router); - getInstalledIntegrationsRoute(router); + getInstalledIntegrationsRoute(router, logger); createTimelinesRoute(router, config, security); patchTimelinesRoute(router, config, security); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.test.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.test.tsx index 7e38fcf81c678..e361c4d98bb77 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.test.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.test.tsx @@ -7,7 +7,7 @@ import React from 'react'; import 'brace'; -import { of } from 'rxjs'; +import { of, Subject } from 'rxjs'; import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers'; import { act } from 'react-dom/test-utils'; import { dataPluginMock } from '@kbn/data-plugin/public/mocks'; @@ -220,6 +220,42 @@ describe('EsQueryAlertTypeExpression', () => { ); }); + test('should show success message if Test Query is successful (with partial result)', async () => { + const partial = { + isRunning: true, + isPartial: true, + }; + const complete = { + isRunning: false, + isPartial: false, + rawResponse: { + hits: { + total: 1234, + }, + }, + }; + const searchResponseMock$ = new Subject(); + dataMock.search.search.mockImplementation(() => searchResponseMock$); + const wrapper = await setup(defaultEsQueryExpressionParams); + const testQueryButton = wrapper.find('EuiButton[data-test-subj="testQuery"]'); + + testQueryButton.simulate('click'); + expect(dataMock.search.search).toHaveBeenCalled(); + await act(async () => { + searchResponseMock$.next(partial); + searchResponseMock$.next(complete); + searchResponseMock$.complete(); + await nextTick(); + wrapper.update(); + }); + + expect(wrapper.find('[data-test-subj="testQuerySuccess"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="testQueryError"]').exists()).toBeFalsy(); + expect(wrapper.find('EuiText[data-test-subj="testQuerySuccess"]').text()).toEqual( + `Query matched 1234 documents in the last 15s.` + ); + }); + test('should show error message if Test Query is throws error', async () => { dataMock.search.search.mockImplementation(() => { throw new Error('What is this query'); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.tsx index 92096ba4541c4..97bf42ca2599a 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/es_query_expression.tsx @@ -6,7 +6,7 @@ */ import React, { useState, Fragment, useEffect, useCallback } from 'react'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; @@ -141,7 +141,7 @@ export const EsQueryExpression = ({ const timeWindow = parseDuration(window); const parsedQuery = JSON.parse(esQuery); const now = Date.now(); - const { rawResponse } = await firstValueFrom( + const { rawResponse } = await lastValueFrom( data.search.search({ params: buildSortedEventsQuery({ index, diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.test.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.test.tsx index 091fd606e1bf0..1ad76de08f5e7 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.test.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.test.tsx @@ -14,8 +14,8 @@ import { EsQueryAlertParams, SearchType } from '../types'; import { SearchSourceExpression } from './search_source_expression'; import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; import { act } from 'react-dom/test-utils'; -import { of } from 'rxjs'; -import { IKibanaSearchResponse, ISearchSource } from '@kbn/data-plugin/common'; +import { Subject } from 'rxjs'; +import { ISearchSource } from '@kbn/data-plugin/common'; import { IUiSettingsClient } from '@kbn/core/public'; import { findTestSubject } from '@elastic/eui/lib/test'; import { EuiLoadingSpinner } from '@elastic/eui'; @@ -40,6 +40,20 @@ const defaultSearchSourceExpressionParams: EsQueryAlertParams { - return of({ - rawResponse: { - hits: { - total: 1234, - }, - }, - }); + return mockSearchResult; }), } as unknown as ISearchSource; @@ -143,6 +151,7 @@ describe('SearchSourceAlertTypeExpression', () => { wrapper = await wrapper.update(); expect(findTestSubject(wrapper, 'thresholdExpression')).toBeTruthy(); }); + test('should show success message if Test Query is successful', async () => { let wrapper = setup(defaultSearchSourceExpressionParams); await act(async () => { @@ -156,6 +165,9 @@ describe('SearchSourceAlertTypeExpression', () => { wrapper = await wrapper.update(); await act(async () => { + mockSearchResult.next(testResultPartial); + mockSearchResult.next(testResultComplete); + mockSearchResult.complete(); await nextTick(); wrapper.update(); }); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression_form.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression_form.tsx index c351a1fe04c6a..bd03babf85a0b 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression_form.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression_form.tsx @@ -7,7 +7,7 @@ import React, { Fragment, useCallback, useEffect, useMemo, useReducer, useState } from 'react'; import deepEqual from 'fast-deep-equal'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { Filter } from '@kbn/es-query'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiSpacer, EuiTitle } from '@elastic/eui'; @@ -183,7 +183,7 @@ export const SearchSourceExpressionForm = (props: SearchSourceExpressionFormProp 'filter', timeFilter ? [timeFilter, ...ruleConfiguration.filter] : ruleConfiguration.filter ); - const { rawResponse } = await firstValueFrom(testSearchSource.fetch$()); + const { rawResponse } = await lastValueFrom(testSearchSource.fetch$()); return { nrOfDocs: totalHitsToNumber(rawResponse.hits.total), timeWindow }; }, [searchSource, timeWindowSize, timeWindowUnit, ruleConfiguration]); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx index e569bf7b93991..d0739baa1ec7a 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx @@ -12,7 +12,7 @@ import { i18n } from '@kbn/i18n'; import { fromKueryExpression, luceneStringToDsl } from '@kbn/es-query'; import { RuleTypeParamsExpressionProps } from '@kbn/triggers-actions-ui-plugin/public'; import { DataView } from '@kbn/data-plugin/common'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { QueryStringInput } from '@kbn/unified-search-plugin/public'; import { GeoContainmentAlertParams } from '../types'; import { EntityIndexExpression } from './expressions/entity_index_expression'; diff --git a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/types.ts b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/types.ts index 719a70858b341..949ebe6ff1e39 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/types.ts +++ b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/types.ts @@ -6,7 +6,7 @@ */ import { RuleTypeParams } from '@kbn/alerting-plugin/common'; -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; export interface GeoContainmentAlertParams extends RuleTypeParams { index: string; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts index 75351e5872f35..23dd326b7e18b 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts @@ -8,7 +8,7 @@ import React, { useCallback, useState } from 'react'; import useDebounce from 'react-use/lib/useDebounce'; import { useDispatch } from 'react-redux'; -import { Query } from '@kbn/data-plugin/common'; +import type { Query } from '@kbn/es-query'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useGetUrlParams, diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/telemetry/types.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/telemetry/types.ts index 4680b844b5ae9..b9178c2d8ad6b 100644 --- a/x-pack/plugins/synthetics/server/legacy_uptime/lib/telemetry/types.ts +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/telemetry/types.ts @@ -41,6 +41,7 @@ export interface MonitorErrorEvent { code?: string; status?: number; url?: string; + kibanaVersion: string; } export interface MonitorUpdateTelemetryChannelEvents { diff --git a/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts b/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts index 0c984a29e7814..02d0f69ddbedc 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts @@ -183,6 +183,7 @@ export class ServiceAPIClient { code: err.code, status: err.response?.data?.status, url, + kibanaVersion: this.server.kibanaVersion, }); if (err.response?.data?.reason) { this.logger.error(err.response?.data?.reason); diff --git a/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts b/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts index 87199e6282b01..8103415af9492 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts @@ -172,6 +172,7 @@ export class SyntheticsService { type: 'runTaskError', code: e?.code, status: e.status, + kibanaVersion: service.server.kibanaVersion, }); throw e; } @@ -217,6 +218,7 @@ export class SyntheticsService { type: 'scheduleTaskError', code: e?.code, status: e.status, + kibanaVersion: this.server.kibanaVersion, }); this.logger?.error( diff --git a/x-pack/plugins/timelines/common/types/field_browser/index.ts b/x-pack/plugins/timelines/common/types/field_browser/index.ts index 9d2b5193c39fb..d365166f25f84 100644 --- a/x-pack/plugins/timelines/common/types/field_browser/index.ts +++ b/x-pack/plugins/timelines/common/types/field_browser/index.ts @@ -38,14 +38,16 @@ export interface FieldBrowserOptions { } export interface FieldBrowserProps { - /** The timeline associated with this field browser */ - timelineId: string; /** The timeline's current column headers */ columnHeaders: ColumnHeaderOptions[]; /** A map of categoryId -> metadata about the fields in that category */ browserFields: BrowserFields; /** When true, this Fields Browser is being used as an "events viewer" */ isEventViewer?: boolean; + /** Callback to reset the default columns */ + onResetColumns: () => void; + /** Callback to toggle a field column */ + onToggleColumn: (fieldId: string) => void; /** The options to customize the field browser, supporting columns rendering and button to create fields */ options?: FieldBrowserOptions; /** The width of the field browser */ diff --git a/x-pack/plugins/timelines/common/types/timeline/index.ts b/x-pack/plugins/timelines/common/types/timeline/index.ts index a19086f583284..8737652b47f4d 100644 --- a/x-pack/plugins/timelines/common/types/timeline/index.ts +++ b/x-pack/plugins/timelines/common/types/timeline/index.ts @@ -323,6 +323,7 @@ export enum TimelineId { test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', rulePreview = 'rule-preview', + kubernetesPageSessions = 'kubernetes-page-sessions', } export const TimelineIdLiteralRt = runtimeTypes.union([ @@ -335,6 +336,7 @@ export const TimelineIdLiteralRt = runtimeTypes.union([ runtimeTypes.literal(TimelineId.active), runtimeTypes.literal(TimelineId.test), runtimeTypes.literal(TimelineId.rulePreview), + runtimeTypes.literal(TimelineId.kubernetesPageSessions), ]); export type TimelineIdLiteral = runtimeTypes.TypeOf; diff --git a/x-pack/plugins/timelines/public/components/field_browser/index.tsx b/x-pack/plugins/timelines/public/components/field_browser/index.tsx index 1d577612a8b8c..b2d803d7ec188 100644 --- a/x-pack/plugins/timelines/public/components/field_browser/index.tsx +++ b/x-pack/plugins/timelines/public/components/field_browser/index.tsx @@ -5,12 +5,7 @@ * 2.0. */ -import React from 'react'; -import type { Store } from 'redux'; -import { Provider } from 'react-redux'; -import { I18nProvider } from '@kbn/i18n-react'; import { FieldBrowser } from '../t_grid/toolbar/field_browser'; -import { FieldBrowserProps } from '../../../common/types/field_browser'; export type { CreateFieldComponent, FieldBrowserOptions, @@ -18,28 +13,5 @@ export type { GetFieldTableColumns, } from '../../../common/types/field_browser'; -const EMPTY_BROWSER_FIELDS = {}; - -export type FieldBrowserWrappedComponentProps = FieldBrowserProps & { - store: Store; -}; - -export const FieldBrowserWrappedComponent = (props: FieldBrowserWrappedComponentProps) => { - const { store, ...restProps } = props; - const fieldBrowserProps = { - ...restProps, - browserFields: restProps.browserFields ?? EMPTY_BROWSER_FIELDS, - }; - return ( - - - - - - ); -}; - -FieldBrowserWrappedComponent.displayName = 'FieldBrowserWrappedComponent'; - // eslint-disable-next-line import/no-default-export -export { FieldBrowserWrappedComponent as default }; +export { FieldBrowser as default }; diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.test.tsx index c91189b509a37..66fd0e828aece 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.test.tsx @@ -16,6 +16,7 @@ import { getColumnWidthFromType, getColumnHeaders, getSchema, + getColumnHeader, } from './helpers'; import { DEFAULT_ACTION_BUTTON_WIDTH, @@ -72,6 +73,40 @@ describe('helpers', () => { }); }); + describe('getColumnHeader', () => { + test('it should return column header non existing in defaultHeaders', () => { + const field = 'test_field_1'; + + expect(getColumnHeader(field, [])).toEqual({ + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_COLUMN_MIN_WIDTH, + }); + }); + + test('it should return column header existing in defaultHeaders', () => { + const field = 'test_field_1'; + + expect( + getColumnHeader(field, [ + { + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + esTypes: ['date'], + type: 'date', + }, + ]) + ).toEqual({ + columnHeaderType: 'not-filtered', + id: field, + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + esTypes: ['date'], + type: 'date', + }); + }); + }); + describe('getColumnHeaders', () => { // additional properties used by `EuiDataGrid`: const actions = { diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.tsx b/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.tsx index 35fd814a7c2f4..ccd3bd3c0fa71 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/body/column_headers/helpers.tsx @@ -21,6 +21,7 @@ import { DEFAULT_DATE_COLUMN_MIN_WIDTH, } from '../constants'; import { allowSorting } from '../helpers'; +import { defaultColumnHeaderType } from './default_headers'; const defaultActions: EuiDataGridColumnActions = { showSortAsc: true, @@ -117,6 +118,19 @@ export const getColumnHeaders = ( : []; }; +/** + * Returns the column header with field details from the defaultHeaders + */ +export const getColumnHeader = ( + fieldName: string, + defaultHeaders: ColumnHeaderOptions[] +): ColumnHeaderOptions => ({ + columnHeaderType: defaultColumnHeaderType, + id: fieldName, + initialWidth: DEFAULT_COLUMN_MIN_WIDTH, + ...(defaultHeaders.find((c) => c.id === fieldName) ?? {}), +}); + export const getColumnWidthFromType = (type: string): number => type !== 'date' ? DEFAULT_COLUMN_MIN_WIDTH : DEFAULT_DATE_COLUMN_MIN_WIDTH; diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx b/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx index 7f14f7452ad3b..308d7f6820efd 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx @@ -54,7 +54,7 @@ import { import type { TimelineItem, TimelineNonEcsData } from '../../../../common/search_strategy/timeline'; -import { getColumnHeaders } from './column_headers/helpers'; +import { getColumnHeader, getColumnHeaders } from './column_headers/helpers'; import { addBuildingBlockStyle, getEventIdToDataMapping, @@ -341,7 +341,7 @@ export const BodyComponent = React.memo( const dispatch = useDispatch(); const getManageTimeline = useMemo(() => tGridSelectors.getManageTimelineById(), []); - const { queryFields, selectAll } = useDeepEqualSelector((state) => + const { queryFields, selectAll, defaultColumns } = useDeepEqualSelector((state) => getManageTimeline(state, id) ); @@ -449,6 +449,32 @@ export const BodyComponent = React.memo( return (bulkActions?.customBulkActions?.length || bulkActions?.alertStatusActions) ?? true; }, [hasAlertsCrud, selectedCount, showCheckboxes, bulkActions]); + const onResetColumns = useCallback(() => { + dispatch(tGridActions.updateColumns({ id, columns: defaultColumns })); + }, [defaultColumns, dispatch, id]); + + const onToggleColumn = useCallback( + (fieldId: string) => { + if (columnHeaders.some(({ id: columnId }) => columnId === fieldId)) { + dispatch( + tGridActions.removeColumn({ + columnId: fieldId, + id, + }) + ); + } else { + dispatch( + tGridActions.upsertColumn({ + column: getColumnHeader(fieldId, defaultColumns), + id, + index: 1, + }) + ); + } + }, + [columnHeaders, dispatch, id, defaultColumns] + ); + const alertToolbar = useMemo( () => ( @@ -523,8 +549,9 @@ export const BodyComponent = React.memo( data-test-subj="field-browser" browserFields={browserFields} options={fieldBrowserOptions} - timelineId={id} columnHeaders={columnHeaders} + onResetColumns={onResetColumns} + onToggleColumn={onToggleColumn} /> )} @@ -556,6 +583,8 @@ export const BodyComponent = React.memo( indexNames, onAlertStatusActionSuccess, onAlertStatusActionFailure, + onResetColumns, + onToggleColumn, additionalBulkActions, refetch, additionalControls, diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.test.tsx index d75089fe86929..edc442e7b5a92 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.test.tsx @@ -13,49 +13,39 @@ import { mockBrowserFields, TestProviders } from '../../../../mock'; import { FIELD_BROWSER_WIDTH } from './helpers'; import { FieldBrowserComponent } from './field_browser'; +import { FieldBrowserProps } from '../../../field_browser'; + +const defaultProps: FieldBrowserProps = { + browserFields: mockBrowserFields, + columnHeaders: [], + onToggleColumn: jest.fn(), + onResetColumns: jest.fn(), +}; + +const renderComponent = (props: Partial = {}) => + render( + + + + ); describe('StatefulFieldsBrowser', () => { - const timelineId = 'test'; - it('should render the Fields button, which displays the fields browser on click', () => { - const result = render( - - - - ); + const result = renderComponent(); expect(result.getByTestId('show-field-browser')).toBeInTheDocument(); }); describe('toggleShow', () => { it('should NOT render the fields browser until the Fields button is clicked', () => { - const result = render( - - - - ); + const result = renderComponent(); expect(result.queryByTestId('fields-browser-container')).toBeNull(); }); it('should render the fields browser when the Fields button is clicked', async () => { - const result = render( - - - - ); + const result = renderComponent(); + result.getByTestId('show-field-browser').click(); await waitFor(() => { expect(result.getByTestId('fields-browser-container')).toBeInTheDocument(); @@ -65,15 +55,7 @@ describe('StatefulFieldsBrowser', () => { describe('updateSelectedCategoryIds', () => { it('should add a selected category, which creates the category badge', async () => { - const result = render( - - - - ); + const result = renderComponent(); result.getByTestId('show-field-browser').click(); await waitFor(() => { @@ -91,15 +73,7 @@ describe('StatefulFieldsBrowser', () => { }); it('should remove a selected category, which deletes the category badge', async () => { - const result = render( - - - - ); + const result = renderComponent(); result.getByTestId('show-field-browser').click(); await waitFor(() => { @@ -121,15 +95,7 @@ describe('StatefulFieldsBrowser', () => { }); it('should update the available categories according to the search input', async () => { - const result = render( - - - - ); + const result = renderComponent(); result.getByTestId('show-field-browser').click(); await waitFor(() => { @@ -149,17 +115,7 @@ describe('StatefulFieldsBrowser', () => { it('should render the Fields Browser button as a settings gear when the isEventViewer prop is true', () => { const isEventViewer = true; - - const result = render( - - - - ); + const result = renderComponent({ isEventViewer }); expect(result.getByTestId('show-field-browser')).toBeInTheDocument(); }); @@ -167,18 +123,7 @@ describe('StatefulFieldsBrowser', () => { it('should render the Fields Browser button as a settings gear when the isEventViewer prop is false', () => { const isEventViewer = false; - const result = render( - - - - ); - + const result = renderComponent({ isEventViewer, width: FIELD_BROWSER_WIDTH }); expect(result.getByTestId('show-field-browser')).toBeInTheDocument(); }); }); diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.tsx index 899d0a10e2984..b683d251005ca 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser.tsx @@ -31,9 +31,10 @@ FieldBrowserButtonContainer.displayName = 'FieldBrowserButtonContainer'; * Manages the state of the field browser */ export const FieldBrowserComponent: React.FC = ({ - timelineId, columnHeaders, browserFields, + onResetColumns, + onToggleColumn, options, width, }) => { @@ -149,13 +150,14 @@ export const FieldBrowserComponent: React.FC = ({ setSelectedCategoryIds={setSelectedCategoryIds} onFilterSelectedChange={onFilterSelectedChange} onHide={onHide} + onResetColumns={onResetColumns} onSearchInputChange={updateFilter} + onToggleColumn={onToggleColumn} options={options} restoreFocusTo={customizeColumnsButtonRef} searchInput={filterInput} appliedFilterInput={appliedFilterInput} selectedCategoryIds={selectedCategoryIds} - timelineId={timelineId} width={width} /> )} diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.test.tsx index e027305530663..b1bdc8e58dd28 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.test.tsx @@ -9,24 +9,12 @@ import { mount } from 'enzyme'; import React from 'react'; import { TestProviders, mockBrowserFields, defaultHeaders } from '../../../../mock'; -import { mockGlobalState } from '../../../../mock/global_state'; -import { tGridActions } from '../../../../store/t_grid'; - import { FieldBrowserModal, FieldBrowserModalProps } from './field_browser_modal'; -import { createStore, State } from '../../../../types'; -import { createSecuritySolutionStorageMock } from '../../../../mock/mock_local_storage'; +const mockOnHide = jest.fn(); +const mockOnToggleColumn = jest.fn(); +const mockOnResetColumns = jest.fn(); -const mockDispatch = jest.fn(); -jest.mock('react-redux', () => { - const original = jest.requireActual('react-redux'); - return { - ...original, - useDispatch: () => mockDispatch, - }; -}); -const timelineId = 'test'; -const onHide = jest.fn(); const testProps: FieldBrowserModalProps = { columnHeaders: [], filteredBrowserFields: mockBrowserFields, @@ -34,15 +22,15 @@ const testProps: FieldBrowserModalProps = { appliedFilterInput: '', isSearching: false, setSelectedCategoryIds: jest.fn(), - onHide, + onHide: mockOnHide, + onResetColumns: mockOnResetColumns, onSearchInputChange: jest.fn(), + onToggleColumn: mockOnToggleColumn, restoreFocusTo: React.createRef(), selectedCategoryIds: [], - timelineId, filterSelectedEnabled: false, onFilterSelectedChange: jest.fn(), }; -const { storage } = createSecuritySolutionStorageMock(); describe('FieldBrowserModal', () => { beforeEach(() => { @@ -67,7 +55,7 @@ describe('FieldBrowserModal', () => { ); wrapper.find('[data-test-subj="close"]').first().simulate('click'); - expect(onHide).toBeCalled(); + expect(mockOnHide).toBeCalled(); }); test('it renders the Reset Fields button', () => { @@ -80,7 +68,7 @@ describe('FieldBrowserModal', () => { expect(wrapper.find('[data-test-subj="reset-fields"]').first().text()).toEqual('Reset Fields'); }); - test('it invokes updateColumns action when the user clicks the Reset Fields button', () => { + test('it invokes onResetColumns callback when the user clicks the Reset Fields button', () => { const wrapper = mount( @@ -88,13 +76,7 @@ describe('FieldBrowserModal', () => { ); wrapper.find('[data-test-subj="reset-fields"]').first().simulate('click'); - - expect(mockDispatch).toBeCalledWith( - tGridActions.updateColumns({ - id: timelineId, - columns: defaultHeaders, - }) - ); + expect(mockOnResetColumns).toHaveBeenCalled(); }); test('it invokes onHide when the user clicks the Reset Fields button', () => { @@ -106,7 +88,7 @@ describe('FieldBrowserModal', () => { wrapper.find('[data-test-subj="reset-fields"]').first().simulate('click'); - expect(onHide).toBeCalled(); + expect(mockOnHide).toBeCalled(); }); test('it renders the search', () => { @@ -173,7 +155,7 @@ describe('FieldBrowserModal', () => { expect(onSearchInputChange).toBeCalledWith(inputText); }); - test('does not render the CreateFieldButton when it is provided but does not have a dataViewId', () => { + test('it renders the CreateFieldButton when it is provided', () => { const MyTestComponent = () =>
{'test'}
; const wrapper = mount( @@ -187,35 +169,6 @@ describe('FieldBrowserModal', () => { ); - expect(wrapper.find(MyTestComponent).exists()).toBeFalsy(); - }); - - test('it renders the CreateFieldButton when it is provided and have a dataViewId', () => { - const state: State = { - ...mockGlobalState, - timelineById: { - ...mockGlobalState.timelineById, - test: { - ...mockGlobalState.timelineById.test, - dataViewId: 'security-solution-default', - }, - }, - }; - const store = createStore(state, storage); - - const MyTestComponent = () =>
{'test'}
; - - const wrapper = mount( - - - - ); - expect(wrapper.find(MyTestComponent).exists()).toBeTruthy(); }); }); diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.tsx index 47acb7ac4f15b..4a0be5f67a54a 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_browser_modal.tsx @@ -17,23 +17,23 @@ import { EuiButtonEmpty, EuiSpacer, } from '@elastic/eui'; -import React, { useCallback, useMemo } from 'react'; -import { useDispatch } from 'react-redux'; +import React, { useCallback } from 'react'; import type { BrowserFields } from '../../../../../common/search_strategy'; import type { FieldBrowserProps, ColumnHeaderOptions } from '../../../../../common/types'; import { Search } from './search'; import { CLOSE_BUTTON_CLASS_NAME, FIELD_BROWSER_WIDTH, RESET_FIELDS_CLASS_NAME } from './helpers'; -import { tGridActions, tGridSelectors } from '../../../../store/t_grid'; import * as i18n from './translations'; -import { useDeepEqualSelector } from '../../../../hooks/use_selector'; import { CategoriesSelector } from './categories_selector'; import { FieldTable } from './field_table'; import { CategoriesBadges } from './categories_badges'; -export type FieldBrowserModalProps = Pick & { +export type FieldBrowserModalProps = Pick< + FieldBrowserProps, + 'width' | 'onResetColumns' | 'onToggleColumn' | 'options' +> & { /** * The current timeline column headers */ @@ -93,6 +93,8 @@ const FieldBrowserModalComponent: React.FC = ({ filterSelectedEnabled, isSearching, onFilterSelectedChange, + onToggleColumn, + onResetColumns, setSelectedCategoryIds, onSearchInputChange, onHide, @@ -100,17 +102,8 @@ const FieldBrowserModalComponent: React.FC = ({ restoreFocusTo, searchInput, selectedCategoryIds, - timelineId, width = FIELD_BROWSER_WIDTH, }) => { - const dispatch = useDispatch(); - - const onUpdateColumns = useCallback( - (columns: ColumnHeaderOptions[]) => - dispatch(tGridActions.updateColumns({ id: timelineId, columns })), - [dispatch, timelineId] - ); - const closeAndRestoreFocus = useCallback(() => { onHide(); setTimeout(() => { @@ -119,15 +112,10 @@ const FieldBrowserModalComponent: React.FC = ({ }, 0); }, [onHide, restoreFocusTo]); - const getManageTimeline = useMemo(() => tGridSelectors.getManageTimelineById(), []); - const { dataViewId, defaultColumns } = useDeepEqualSelector((state) => - getManageTimeline(state, timelineId) - ); - - const onResetColumns = useCallback(() => { - onUpdateColumns(defaultColumns); + const resetColumns = useCallback(() => { + onResetColumns(); closeAndRestoreFocus(); - }, [onUpdateColumns, closeAndRestoreFocus, defaultColumns]); + }, [closeAndRestoreFocus, onResetColumns]); /** Invoked when the user types in the input to filter the field browser */ const onInputChange = useCallback( @@ -159,7 +147,6 @@ const FieldBrowserModalComponent: React.FC = ({ isSearching={isSearching} onSearchInputChange={onInputChange} searchInput={searchInput} - timelineId={timelineId} /> @@ -170,9 +157,7 @@ const FieldBrowserModalComponent: React.FC = ({ /> - {CreateFieldButton && dataViewId != null && dataViewId.length > 0 && ( - - )} + {CreateFieldButton && } @@ -184,13 +169,13 @@ const FieldBrowserModalComponent: React.FC = ({ @@ -201,7 +186,7 @@ const FieldBrowserModalComponent: React.FC = ({ {i18n.RESET_FIELDS} diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_items.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_items.tsx index 5d255e6d6c2d2..e85285249c2f0 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_items.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_items.tsx @@ -29,12 +29,9 @@ import type { FieldTableColumns, GetFieldTableColumns, } from '../../../../../common/types'; -import { defaultColumnHeaderType } from '../../body/column_headers/default_headers'; -import { DEFAULT_COLUMN_MIN_WIDTH } from '../../body/constants'; import { TruncatableText } from '../../../truncatable_text'; import { FieldName } from './field_name'; import * as i18n from './translations'; -import { getAlertColumnHeader } from './helpers'; const TypeIcon = styled(EuiIcon)` margin: 0 4px; @@ -87,16 +84,6 @@ export const getFieldItems = ({ ); }; -/** - * Returns the column header for a field - */ -export const getColumnHeader = (timelineId: string, fieldName: string): ColumnHeaderOptions => ({ - columnHeaderType: defaultColumnHeaderType, - id: fieldName, - initialWidth: DEFAULT_COLUMN_MIN_WIDTH, - ...getAlertColumnHeader(timelineId, fieldName), -}); - const getDefaultFieldTableColumns = (highlight: string): FieldTableColumns => [ { field: 'name', diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.test.tsx index 77d5a754d6a97..5995870ce933a 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.test.tsx @@ -8,22 +8,12 @@ import React from 'react'; import { render, RenderResult } from '@testing-library/react'; import { mockBrowserFields, TestProviders } from '../../../../mock'; -import { tGridActions } from '../../../../store/t_grid'; import { defaultColumnHeaderType } from '../../body/column_headers/default_headers'; -import { DEFAULT_COLUMN_MIN_WIDTH, DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../body/constants'; +import { DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../body/constants'; import { ColumnHeaderOptions } from '../../../../../common'; import { FieldTable, FieldTableProps } from './field_table'; -const mockDispatch = jest.fn(); -jest.mock('react-redux', () => { - const original = jest.requireActual('react-redux'); - return { - ...original, - useDispatch: () => mockDispatch, - }; -}); - const timestampFieldId = '@timestamp'; const columnHeaders: ColumnHeaderOptions[] = [ @@ -39,16 +29,18 @@ const columnHeaders: ColumnHeaderOptions[] = [ initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, }, ]; -const timelineId = 'test'; + +const mockOnToggleColumn = jest.fn(); + const defaultProps: FieldTableProps = { selectedCategoryIds: [], columnHeaders: [], filteredBrowserFields: {}, searchInput: '', - timelineId, filterSelectedEnabled: false, onFilterSelectedChange: jest.fn(), onHide: jest.fn(), + onToggleColumn: mockOnToggleColumn, }; describe('FieldTable', () => { @@ -56,7 +48,7 @@ describe('FieldTable', () => { const defaultPageSize = 10; beforeEach(() => { - mockDispatch.mockClear(); + jest.clearAllMocks(); }); it('should render empty field table', () => { @@ -156,7 +148,7 @@ describe('FieldTable', () => { }); describe('selection', () => { - it('should dispatch remove column action on field unchecked', () => { + it('should call onToggleColumn callback when field unchecked', () => { const result = render( { result.getByTestId(`field-${timestampFieldId}-checkbox`).click(); - expect(mockDispatch).toHaveBeenCalledTimes(1); - expect(mockDispatch).toHaveBeenCalledWith( - tGridActions.removeColumn({ id: timelineId, columnId: timestampFieldId }) - ); + expect(mockOnToggleColumn).toHaveBeenCalledTimes(1); + expect(mockOnToggleColumn).toHaveBeenCalledWith(timestampFieldId); }); - it('should dispatch upsert column action on field checked', () => { + it('should call onToggleColumn callback when field checked', () => { const result = render( { result.getByTestId(`field-${timestampFieldId}-checkbox`).click(); - expect(mockDispatch).toHaveBeenCalledTimes(1); - expect(mockDispatch).toHaveBeenCalledWith( - tGridActions.upsertColumn({ - id: timelineId, - column: { - columnHeaderType: defaultColumnHeaderType, - id: timestampFieldId, - initialWidth: DEFAULT_COLUMN_MIN_WIDTH, - }, - index: 1, - }) - ); + expect(mockOnToggleColumn).toHaveBeenCalledTimes(1); + expect(mockOnToggleColumn).toHaveBeenCalledWith(timestampFieldId); }); }); @@ -241,7 +221,7 @@ describe('FieldTable', () => { changePage(result); result.getAllByRole('checkbox').at(0)?.click(); - expect(mockDispatch).toHaveBeenCalled(); // assert some field has been selected + expect(mockOnToggleColumn).toHaveBeenCalled(); // assert some field has been selected expect(isAtFirstPage(result)).toBeFalsy(); }); diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.tsx index e682324d7b1e6..99f3e641fc6f1 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/field_table.tsx @@ -8,11 +8,9 @@ import React, { useCallback, useEffect, useMemo, useState } from 'react'; import styled from 'styled-components'; import { EuiInMemoryTable, Pagination, Direction } from '@elastic/eui'; -import { useDispatch } from 'react-redux'; import { BrowserFields, ColumnHeaderOptions } from '../../../../../common'; -import { getColumnHeader, getFieldColumns, getFieldItems, isActionsColumn } from './field_items'; +import { getFieldColumns, getFieldItems, isActionsColumn } from './field_items'; import { CATEGORY_TABLE_CLASS_NAME, TABLE_HEIGHT } from './helpers'; -import { tGridActions } from '../../../../store/t_grid'; import type { GetFieldTableColumns } from '../../../../../common/types/field_browser'; import { FieldTableHeader } from './field_table_header'; @@ -22,7 +20,6 @@ const DEFAULT_SORTING: { field: string; direction: Direction } = { } as const; export interface FieldTableProps { - timelineId: string; columnHeaders: ColumnHeaderOptions[]; /** * A map of categoryId -> metadata about the fields in that category, @@ -33,6 +30,7 @@ export interface FieldTableProps { /** when true, show only the the selected field */ filterSelectedEnabled: boolean; onFilterSelectedChange: (enabled: boolean) => void; + onToggleColumn: (fieldId: string) => void; /** * Optional function to customize field table columns */ @@ -71,7 +69,7 @@ const FieldTableComponent: React.FC = ({ searchInput, selectedCategoryIds, onFilterSelectedChange, - timelineId, + onToggleColumn, onHide, }) => { const [pageIndex, setPageIndex] = useState(0); @@ -80,8 +78,6 @@ const FieldTableComponent: React.FC = ({ const [sortField, setSortField] = useState(DEFAULT_SORTING.field); const [sortDirection, setSortDirection] = useState(DEFAULT_SORTING.direction); - const dispatch = useDispatch(); - const fieldItems = useMemo( () => getFieldItems({ @@ -92,28 +88,6 @@ const FieldTableComponent: React.FC = ({ [columnHeaders, filteredBrowserFields, selectedCategoryIds] ); - const onToggleColumn = useCallback( - (fieldId: string) => { - if (columnHeaders.some(({ id }) => id === fieldId)) { - dispatch( - tGridActions.removeColumn({ - columnId: fieldId, - id: timelineId, - }) - ); - } else { - dispatch( - tGridActions.upsertColumn({ - column: getColumnHeader(timelineId, fieldId), - id: timelineId, - index: 1, - }) - ); - } - }, - [columnHeaders, dispatch, timelineId] - ); - /** * Pagination controls */ diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/helpers.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/helpers.tsx index fd590c468b7e7..d35eb49c9cc17 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/helpers.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/helpers.tsx @@ -8,9 +8,7 @@ import { EuiBadge, EuiLoadingSpinner } from '@elastic/eui'; import styled from 'styled-components'; -import { TimelineId } from '../../../../types'; import type { BrowserField, BrowserFields } from '../../../../../common/search_strategy'; -import { defaultHeaders } from '../../../../store/t_grid/defaults'; import { ColumnHeaderOptions } from '../../../../../common'; export const LoadingSpinner = styled(EuiLoadingSpinner)` @@ -149,11 +147,6 @@ export const filterSelectedBrowserFields = ({ return result; }; -export const getAlertColumnHeader = (timelineId: string, fieldId: string) => - timelineId === TimelineId.detectionsPage || timelineId === TimelineId.detectionsRulesDetailsPage - ? defaultHeaders.find((c) => c.id === fieldId) ?? {} - : {}; - export const CATEGORY_TABLE_CLASS_NAME = 'category-table'; export const CLOSE_BUTTON_CLASS_NAME = 'close-button'; export const RESET_FIELDS_CLASS_NAME = 'reset-fields'; diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.test.tsx index fb6363e244459..e3a6f2770af95 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.test.tsx @@ -10,18 +10,11 @@ import React from 'react'; import { TestProviders } from '../../../../mock'; import { Search } from './search'; -const timelineId = 'test'; - describe('Search', () => { test('it renders the field search input with the expected placeholder text when the searchInput prop is empty', () => { const wrapper = mount( - + ); @@ -35,12 +28,7 @@ describe('Search', () => { const wrapper = mount( - + ); @@ -50,12 +38,7 @@ describe('Search', () => { test('it renders the field search input with a spinner when isSearching is true', () => { const wrapper = mount( - + ); @@ -67,12 +50,7 @@ describe('Search', () => { const wrapper = mount( - + ); diff --git a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.tsx b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.tsx index 037dcdc9033d2..325d650b53f06 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/toolbar/field_browser/search.tsx @@ -12,22 +12,19 @@ interface Props { isSearching: boolean; onSearchInputChange: (event: React.ChangeEvent) => void; searchInput: string; - timelineId: string; } const inputRef = (node: HTMLInputElement | null) => node?.focus(); -export const Search = React.memo( - ({ isSearching, onSearchInputChange, searchInput, timelineId }) => ( - - ) -); +export const Search = React.memo(({ isSearching, onSearchInputChange, searchInput }) => ( + +)); Search.displayName = 'Search'; diff --git a/x-pack/plugins/timelines/public/methods/index.tsx b/x-pack/plugins/timelines/public/methods/index.tsx index c153039e815ee..1aec4aab20c4c 100644 --- a/x-pack/plugins/timelines/public/methods/index.tsx +++ b/x-pack/plugins/timelines/public/methods/index.tsx @@ -74,10 +74,10 @@ export const getLoadingPanelLazy = (props: LoadingPanelProps) => { }; const FieldBrowserLazy = lazy(() => import('../components/field_browser')); -export const getFieldBrowserLazy = (props: FieldBrowserProps, { store }: { store: Store }) => { +export const getFieldBrowserLazy = (props: FieldBrowserProps) => { return ( }> - + ); }; diff --git a/x-pack/plugins/timelines/public/plugin.ts b/x-pack/plugins/timelines/public/plugin.ts index d18d7320f7577..d0bb94a2b68fb 100644 --- a/x-pack/plugins/timelines/public/plugin.ts +++ b/x-pack/plugins/timelines/public/plugin.ts @@ -75,10 +75,7 @@ export class TimelinesPlugin implements Plugin { return getLastUpdatedLazy(props); }, getFieldBrowser: (props: FieldBrowserProps) => { - return getFieldBrowserLazy(props, { - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - store: this._store!, - }); + return getFieldBrowserLazy(props); }, getUseAddToTimeline: () => { return useAddToTimeline; diff --git a/x-pack/plugins/timelines/public/store/t_grid/types.ts b/x-pack/plugins/timelines/public/store/t_grid/types.ts index 8e0b7e995dbcd..c7127f16385af 100644 --- a/x-pack/plugins/timelines/public/store/t_grid/types.ts +++ b/x-pack/plugins/timelines/public/store/t_grid/types.ts @@ -54,6 +54,7 @@ export enum TimelineId { casePage = 'timeline-case', test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', + kubernetesPageSessions = 'kubernetes-page-sessions', } export interface InitialyzeTGridSettings extends Partial { diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_search_bar.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_search_bar.ts index 486e9e4da79e2..4ea56b557c7ee 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_search_bar.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_search_bar.ts @@ -8,7 +8,7 @@ import { useState } from 'react'; import { toElasticsearchQuery, fromKueryExpression, luceneStringToDsl } from '@kbn/es-query'; -import { Query } from '@kbn/data-plugin/public'; +import type { Query } from '@kbn/es-query'; import { getPivotQuery } from '../../../../../common'; diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index b2f095bd838cb..3eeda946ada8f 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -365,8 +365,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "Nom de la colonne dans laquelle le taux de compteur résultant sera stocké", "xpack.lens.functions.counterRate.help": "Calcule le taux de compteur d'une colonne dans un tableau de données", "xpack.lens.functions.lastValue.missingSortField": "Cette vue de données ne contient aucun champ de date.", - "xpack.lens.functions.renameColumns.help": "Aide pour renommer les colonnes d'un tableau de données", - "xpack.lens.functions.renameColumns.idMap.help": "Un objet encodé JSON dans lequel les clés sont les anciens ID de colonne et les valeurs sont les nouveaux ID correspondants. Tous les autres ID de colonne sont conservés.", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "L'ID de colonne de date {columnId} n'existe pas.", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "Impossible de récupérer les informations d'histogramme des dates", "xpack.lens.gauge.addLayer": "Visualisation", @@ -5338,12 +5336,11 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "ID du localisateur non spécifié. Spécifiez le paramètre de recherche \"l\" dans l'URL ; ce devrait être un ID de localisateur existant.", "share.urlService.redirect.RedirectManager.missingParamParams": "Paramètres du localisateur non spécifiés. Spécifiez le paramètre de recherche \"p\" dans l'URL ; ce devrait être un objet sérialisé JSON des paramètres du localisateur.", "share.urlService.redirect.RedirectManager.missingParamVersion": "Version des paramètres du localisateur non spécifiée. Spécifiez le paramètre de recherche \"v\" dans l'URL ; ce devrait être la version de Kibana au moment de la génération des paramètres du localisateur.", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "Utilisez Elastic Agent pour collecter de manière simple et unifiée les données de vos machines.", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "Cette intégration n'est pas encore activée. Votre administrateur possède les autorisations requises pour l’activer.", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "Contactez votre administrateur", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "Ajouter Elastic Agent", - "sharedUXComponents.pageTemplate.noDataCard.description": "Continuer sans collecter de données", - "sharedUXComponents.toolbar.buttons.addFromLibrary.libraryButtonLabel": "Ajouter depuis la bibliothèque", + "sharedUXPackages.card.noData.description": "Utilisez Elastic Agent pour collecter de manière simple et unifiée les données de vos machines.", + "sharedUXPackages.card.noData.noPermission.description": "Cette intégration n'est pas encore activée. Votre administrateur possède les autorisations requises pour l’activer.", + "sharedUXPackages.card.noData.noPermission.title": "Contactez votre administrateur", + "sharedUXPackages.card.noData.title": "Ajouter Elastic Agent", + "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "Ajouter depuis la bibliothèque", "sharedUXPackages.noDataViewsPrompt.learnMore": "Envie d'en savoir plus ?", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "Lisez les documents", "telemetry.callout.appliesSettingTitle": "Les modifications apportées à ce paramètre s'appliquent dans {allOfKibanaText} et sont enregistrées automatiquement.", diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index fecfabdb7b16a..2fa35f6e723b2 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -367,8 +367,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "結果のカウンターレートを格納する列の名前", "xpack.lens.functions.counterRate.help": "データテーブルの列のカウンターレートを計算します", "xpack.lens.functions.lastValue.missingSortField": "このデータビューには日付フィールドが含まれていません", - "xpack.lens.functions.renameColumns.help": "データベースの列の名前の変更をアシストします", - "xpack.lens.functions.renameColumns.idMap.help": "キーが古い列 ID で値が対応する新しい列 ID となるように JSON エンコーディングされたオブジェクトです。他の列 ID はすべてのそのままです。", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "指定した dateColumnId {columnId} は存在しません。", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "日付ヒストグラム情報を取得できませんでした", "xpack.lens.gauge.addLayer": "ビジュアライゼーション", @@ -5440,12 +5438,11 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "ロケｰターIDが指定されていません。URLで「l」検索パラメーターを指定します。これは既存のロケｰターIDにしてください。", "share.urlService.redirect.RedirectManager.missingParamParams": "ロケーターパラメーターが指定されていません。URLで「p」検索パラメーターを指定します。これはロケーターパラメーターのJSONシリアル化オブジェクトにしてください。", "share.urlService.redirect.RedirectManager.missingParamVersion": "ロケーターパラメーターバージョンが指定されていません。URLで「v」検索パラメーターを指定します。これはロケーターパラメーターが生成されたときのKibanaのリリースバージョンです。", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "Elasticエージェントを使用すると、シンプルで統一された方法でコンピューターからデータを収集するできます。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "この統合はまだ有効ではありません。管理者にはオンにするために必要なアクセス権があります。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "管理者にお問い合わせください", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "Elasticエージェントの追加", - "sharedUXComponents.pageTemplate.noDataCard.description": "データを収集せずに続行", - "sharedUXComponents.toolbar.buttons.addFromLibrary.libraryButtonLabel": "ライブラリから追加", + "sharedUXPackages.card.noData.description": "Elasticエージェントを使用すると、シンプルで統一された方法でコンピューターからデータを収集するできます。", + "sharedUXPackages.card.noData.noPermission.description": "この統合はまだ有効ではありません。管理者にはオンにするために必要なアクセス権があります。", + "sharedUXPackages.card.noData.noPermission.title": "管理者にお問い合わせください", + "sharedUXPackages.card.noData.title": "Elasticエージェントの追加", + "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "ライブラリから追加", "sharedUXPackages.noDataViewsPrompt.learnMore": "詳細について", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "ドキュメントを読む", "telemetry.callout.appliesSettingTitle": "この設定に加えた変更は {allOfKibanaText} に適用され、自動的に保存されます。", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index 1cc41035906d5..01b30dda57b2c 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -372,8 +372,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "要存储结果计数率的列名称", "xpack.lens.functions.counterRate.help": "在数据表中计算列的计数率", "xpack.lens.functions.lastValue.missingSortField": "此数据视图不包含任何日期字段", - "xpack.lens.functions.renameColumns.help": "用于重命名数据表列的助手", - "xpack.lens.functions.renameColumns.idMap.help": "旧列 ID 为键且相应新列 ID 为值的 JSON 编码对象。所有其他列 ID 都将保留。", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "指定的 dateColumnId {columnId} 不存在。", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "无法获取日期直方图信息", "xpack.lens.gauge.addLayer": "可视化", @@ -5451,12 +5449,11 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "未指定定位器 ID。在 URL 中指定“l”搜索参数，其应为现有定位器 ID。", "share.urlService.redirect.RedirectManager.missingParamParams": "定位器参数未指定。在 URL 中指定“p”搜索参数，其应为定位器参数的 JSON 序列化对象。", "share.urlService.redirect.RedirectManager.missingParamVersion": "定位器参数版本未指定。在 URL 中指定“v”搜索参数，其应为生成定位器参数时 Kibana 的版本。", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "使用 Elastic 代理以简单统一的方式从您的计算机中收集数据。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "尚未启用此集成。您的管理员具有打开它所需的权限。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "请联系您的管理员", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "添加 Elastic 代理", - "sharedUXComponents.pageTemplate.noDataCard.description": "继续，而不收集数据", - "sharedUXComponents.toolbar.buttons.addFromLibrary.libraryButtonLabel": "从库中添加", + "sharedUXPackages.card.noData.description": "使用 Elastic 代理以简单统一的方式从您的计算机中收集数据。", + "sharedUXPackages.card.noData.noPermission.description": "尚未启用此集成。您的管理员具有打开它所需的权限。", + "sharedUXPackages.card.noData.noPermission.title": "请联系您的管理员", + "sharedUXPackages.card.noData.title": "添加 Elastic 代理", + "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "从库中添加", "sharedUXPackages.noDataViewsPrompt.learnMore": "希望了解详情？", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "阅读文档", "telemetry.callout.appliesSettingTitle": "对此设置的更改将应用到{allOfKibanaText} 且会自动保存。", diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/translations.ts b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/translations.ts index 504e95636749b..7c6fab2b18792 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/translations.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/translations.ts @@ -146,6 +146,14 @@ export const API_INFO_ERROR = (status: number) => defaultMessage: 'Received status: {status} when attempting to get application information', }); +export const FETCH_ERROR = i18n.translate( + 'xpack.triggersActionsUI.components.builtinActionTypes.servicenow.fetchErrorMsg', + { + defaultMessage: + 'Failed to fetch. Check the URL or the CORS configuration of your ServiceNow instance.', + } +); + export const INSTALLATION_CALLOUT_TITLE = i18n.translate( 'xpack.triggersActionsUI.components.builtinActionTypes.servicenow.installationCalloutTitle', { diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.test.tsx index c8b1f3be71ff7..f8e9a2c4bac1a 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.test.tsx @@ -99,4 +99,28 @@ describe('useGetAppInfo', () => { }) ).rejects.toThrow('An error occurred'); }); + + it('it throws an error when fetch fails', async () => { + expect.assertions(1); + getAppInfoMock.mockImplementation(() => { + const error = new Error('An error occurred'); + error.name = 'TypeError'; + throw error; + }); + + const { result } = renderHook(() => + useGetAppInfo({ + actionTypeId, + http, + }) + ); + + await expect(() => + act(async () => { + await result.current.fetchAppInfo(actionConnector); + }) + ).rejects.toThrow( + 'Failed to fetch. Check the URL or the CORS configuration of your ServiceNow instance.' + ); + }); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.tsx index a086071a63487..b0b295c9b7269 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/use_get_app_info.tsx @@ -10,6 +10,7 @@ import { useState, useEffect, useRef, useCallback } from 'react'; import { HttpStart } from '@kbn/core/public'; import { getAppInfo } from './api'; import { AppInfo, RESTApiError, ServiceNowActionConnector } from './types'; +import { FETCH_ERROR } from './translations'; export interface UseGetAppInfoProps { actionTypeId?: string; @@ -56,6 +57,18 @@ export const useGetAppInfo = ({ actionTypeId, http }: UseGetAppInfoProps): UseGe if (!didCancel.current) { setIsLoading(false); } + + /** + * According to https://developer.mozilla.org/en-US/docs/Web/API/fetch#exceptions + * all network errors throw a TypeError. Usually fetch errors are happening + * due to CORS misconfiguration. By detecting fetch errors we can provide + * a better message about CORS. Adding a CORS rule to allow requests from the UI + * in the ServiceNow instance is needed by our ServiceNow applications. + */ + if (error.name === 'TypeError') { + throw new Error(FETCH_ERROR); + } + throw error; } }, diff --git a/x-pack/plugins/triggers_actions_ui/public/application/internal/shareable_components_sandbox/rule_status_dropdown_sandbox.tsx b/x-pack/plugins/triggers_actions_ui/public/application/internal/shareable_components_sandbox/rule_status_dropdown_sandbox.tsx index e17721930858d..0cbbc8f0ee9f8 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/internal/shareable_components_sandbox/rule_status_dropdown_sandbox.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/internal/shareable_components_sandbox/rule_status_dropdown_sandbox.tsx @@ -6,6 +6,7 @@ */ import React, { useState } from 'react'; +import moment from 'moment'; import { getRuleStatusDropdownLazy } from '../../../common/get_rule_status_dropdown'; export const RuleStatusDropdownSandbox: React.FC<{}> = () => { @@ -25,12 +26,12 @@ export const RuleStatusDropdownSandbox: React.FC<{}> = () => { setIsSnoozedUntil(null); }, disableRule: async () => setEnabled(false), - snoozeRule: async (time) => { - if (time === -1) { + snoozeRule: async (schedule) => { + if (schedule.duration === -1) { setIsSnoozedUntil(null); setMuteAll(true); } else { - setIsSnoozedUntil(new Date(time)); + setIsSnoozedUntil(moment(schedule.rRule.dtstart).add(schedule.duration, 'ms').toDate()); setMuteAll(false); } }, diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/i18n_month_day_date.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/i18n_month_day_date.ts new file mode 100644 index 0000000000000..6730cb5bf3d1d --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/i18n_month_day_date.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { Moment } from 'moment'; + +export const i18nMonthDayDate = (date: Moment) => i18nLocalDateWithoutYear(date, 'LL'); +export const i18nAbbrMonthDayDate = (date: Moment) => i18nLocalDateWithoutYear(date, 'll'); + +const i18nLocalDateWithoutYear = (date: Moment, format: string) => + date + .format(format) + // We want to produce the local equivalent of DD MMM (e.g. MMM DD in US, China, Japan, Hungary, etc.) + // but Moment doesn't let us format just DD MMM according to locale, only DD MM(,?) YYYY, + // so regex replace the year and any commas from the LL formatted string + .replace(new RegExp(`(${date.format('YYYY')}|,)`, 'g'), '') + .trim(); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.test.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.test.ts index acc854caa06f4..a220d4893d55d 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.test.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.test.ts @@ -13,14 +13,25 @@ beforeEach(() => jest.resetAllMocks()); describe('snoozeRule', () => { test('should call mute alert API', async () => { - const result = await snoozeRule({ http, id: '1/', snoozeEndTime: '9999-01-01T00:00:00.000Z' }); + const result = await snoozeRule({ + http, + id: '1/', + snoozeSchedule: { + id: null, + duration: 864000000, + rRule: { + dtstart: '9999-01-01T00:00:00.000Z', + tzid: 'UTC', + }, + }, + }); expect(result).toEqual(undefined); expect(http.post.mock.calls).toMatchInlineSnapshot(` Array [ Array [ "/internal/alerting/rule/1%2F/_snooze", Object { - "body": "{\\"snooze_end_time\\":\\"9999-01-01T00:00:00.000Z\\"}", + "body": "{\\"snooze_schedule\\":{\\"duration\\":864000000,\\"rRule\\":{\\"dtstart\\":\\"9999-01-01T00:00:00.000Z\\",\\"tzid\\":\\"UTC\\"}}}", }, ], ] diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts index d1f47bbec012e..ecefa038d539e 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts @@ -5,20 +5,32 @@ * 2.0. */ import { HttpSetup } from '@kbn/core/public'; +import { SnoozeSchedule } from '../../../types'; import { INTERNAL_BASE_ALERTING_API_PATH } from '../../constants'; +function rewriteSnoozeSchedule({ id, duration, rRule }: SnoozeSchedule) { + return { + ...(id ? { id } : {}), + duration, + rRule: { + ...rRule, + ...(rRule.until ? { until: rRule.until.toISOString() } : {}), + }, + }; +} + export async function snoozeRule({ id, - snoozeEndTime, + snoozeSchedule, http, }: { id: string; - snoozeEndTime: string | -1; + snoozeSchedule: SnoozeSchedule; http: HttpSetup; }): Promise { await http.post(`${INTERNAL_BASE_ALERTING_API_PATH}/rule/${encodeURIComponent(id)}/_snooze`, { body: JSON.stringify({ - snooze_end_time: snoozeEndTime, + snooze_schedule: rewriteSnoozeSchedule(snoozeSchedule), }), }); } diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.test.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.test.ts index d0a9707cbedf5..59211873eb1d3 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.test.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.test.ts @@ -19,6 +19,9 @@ describe('muteRule', () => { Array [ Array [ "/internal/alerting/rule/1%2F/_unsnooze", + Object { + "body": "{}", + }, ], ] `); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts index 3f0ccd0aeab4d..91880fd9e6206 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts @@ -7,6 +7,18 @@ import { HttpSetup } from '@kbn/core/public'; import { INTERNAL_BASE_ALERTING_API_PATH } from '../../constants'; -export async function unsnoozeRule({ id, http }: { id: string; http: HttpSetup }): Promise { - await http.post(`${INTERNAL_BASE_ALERTING_API_PATH}/rule/${encodeURIComponent(id)}/_unsnooze`); +export async function unsnoozeRule({ + id, + http, + scheduleIds, +}: { + id: string; + http: HttpSetup; + scheduleIds?: string[]; +}): Promise { + await http.post(`${INTERNAL_BASE_ALERTING_API_PATH}/rule/${encodeURIComponent(id)}/_unsnooze`, { + body: JSON.stringify({ + schedule_ids: scheduleIds, + }), + }); } diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx index e82bbaad26743..071f216bbb6c0 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx @@ -15,6 +15,7 @@ import { RuleSummary, AlertingFrameworkHealth, ResolvedRule, + SnoozeSchedule, } from '../../../../types'; import { deleteRules, @@ -69,8 +70,8 @@ export interface ComponentOpts { ) => Promise; getHealth: () => Promise; resolveRule: (id: Rule['id']) => Promise; - snoozeRule: (rule: Rule, snoozeEndTime: string | -1) => Promise; - unsnoozeRule: (rule: Rule) => Promise; + snoozeRule: (rule: Rule, snoozeSchedule: SnoozeSchedule) => Promise; + unsnoozeRule: (rule: Rule, scheduleIds?: string[]) => Promise; } export type PropsWithOptionalApiHandlers = Omit & Partial; @@ -149,11 +150,11 @@ export function withBulkRuleOperations( } resolveRule={async (ruleId: Rule['id']) => resolveRule({ http, ruleId })} getHealth={async () => alertingFrameworkHealth({ http })} - snoozeRule={async (rule: Rule, snoozeEndTime: string | -1) => { - return await snoozeRule({ http, id: rule.id, snoozeEndTime }); + snoozeRule={async (rule: Rule, snoozeSchedule: SnoozeSchedule) => { + return await snoozeRule({ http, id: rule.id, snoozeSchedule }); }} - unsnoozeRule={async (rule: Rule) => { - return await unsnoozeRule({ http, id: rule.id }); + unsnoozeRule={async (rule: Rule, scheduleIds?: string[]) => { + return await unsnoozeRule({ http, id: rule.id, scheduleIds }); }} /> ); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_details.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_details.tsx index 4faae3f2b26d5..1fd38ba063098 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_details.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_details.tsx @@ -327,10 +327,10 @@ export const RuleDetails: React.FunctionComponent = ({ await disableRule(rule)} enableRule={async () => await enableRule(rule)} - snoozeRule={async (snoozeEndTime: string | -1) => - await snoozeRule(rule, snoozeEndTime) - } - unsnoozeRule={async () => await unsnoozeRule(rule)} + snoozeRule={async (snoozeSchedule) => { + await snoozeRule(rule, snoozeSchedule); + }} + unsnoozeRule={async (scheduleIds) => await unsnoozeRule(rule, scheduleIds)} rule={rule as RuleTableItem} onRuleChanged={requestRefresh} direction="row" diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/collapsed_item_actions.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/collapsed_item_actions.tsx index fb64082868525..95e2aceb0f292 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/collapsed_item_actions.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/collapsed_item_actions.tsx @@ -21,14 +21,19 @@ import { } from '@elastic/eui'; import { useKibana } from '../../../../common/lib/kibana'; -import { RuleTableItem } from '../../../../types'; +import { RuleTableItem, SnoozeSchedule } from '../../../../types'; import { ComponentOpts as BulkOperationsComponentOpts, withBulkRuleOperations, } from '../../common/components/with_bulk_rule_api_operations'; -import { RulesListSnoozePanel } from './rules_list_snooze_panel'; import { isRuleSnoozed } from './rule_status_dropdown'; import './collapsed_item_actions.scss'; +import { futureTimeToInterval, SnoozePanel } from './rule_snooze'; +import { + SNOOZE_FAILED_MESSAGE, + SNOOZE_SUCCESS_MESSAGE, + UNSNOOZE_SUCCESS_MESSAGE, +} from './rules_list_notify_badge'; export type ComponentOpts = { item: RuleTableItem; @@ -51,7 +56,10 @@ export const CollapsedItemActions: React.FunctionComponent = ({ snoozeRule, unsnoozeRule, }: ComponentOpts) => { - const { ruleTypeRegistry } = useKibana().services; + const { + ruleTypeRegistry, + notifications: { toasts }, + } = useKibana().services; const [isPopoverOpen, setIsPopoverOpen] = useState(false); const [isDisabled, setIsDisabled] = useState(!item.enabled); @@ -59,20 +67,44 @@ export const CollapsedItemActions: React.FunctionComponent = ({ setIsDisabled(!item.enabled); }, [item.enabled]); + const onClose = useCallback(() => { + setIsPopoverOpen(false); + }, [setIsPopoverOpen]); + const snoozeRuleInternal = useCallback( - async (snoozeEndTime: string | -1, interval: string | null) => { - await snoozeRule(item, snoozeEndTime); + async (snoozeSchedule: SnoozeSchedule) => { + try { + onLoading(true); + await snoozeRule(item, snoozeSchedule); + onRuleChanged(); + toasts.addSuccess(SNOOZE_SUCCESS_MESSAGE); + } catch (e) { + toasts.addDanger(SNOOZE_FAILED_MESSAGE); + } finally { + onLoading(false); + onClose(); + } + await snoozeRule(item, snoozeSchedule); }, - [snoozeRule, item] + [onLoading, snoozeRule, item, onRuleChanged, toasts, onClose] ); - const unsnoozeRuleInternal = useCallback(async () => { - await unsnoozeRule(item); - }, [unsnoozeRule, item]); - - const onClose = useCallback(() => { - setIsPopoverOpen(false); - }, [setIsPopoverOpen]); + const unsnoozeRuleInternal = useCallback( + async (scheduleIds?: string[]) => { + try { + onLoading(true); + await unsnoozeRule(item, scheduleIds); + onRuleChanged(); + toasts.addSuccess(UNSNOOZE_SUCCESS_MESSAGE); + } catch (e) { + toasts.addDanger(SNOOZE_FAILED_MESSAGE); + } finally { + onLoading(false); + onClose(); + } + }, + [onLoading, unsnoozeRule, item, onRuleChanged, toasts, onClose] + ); const isRuleTypeEditableInContext = ruleTypeRegistry.has(item.ruleTypeId) ? !ruleTypeRegistry.get(item.ruleTypeId).requiresAppContext @@ -224,7 +256,7 @@ export const CollapsedItemActions: React.FunctionComponent = ({ {i18n.translate( 'xpack.triggersActionsUI.sections.rulesList.collapsedItemActons.snoozeActions', - { defaultMessage: 'Snooze actions' } + { defaultMessage: 'Snooze notifications' } )} @@ -232,11 +264,11 @@ export const CollapsedItemActions: React.FunctionComponent = ({ width: 500, content: ( - diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/index.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/index.tsx new file mode 100644 index 0000000000000..2f2141da528b5 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/index.tsx @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { SnoozePanel, futureTimeToInterval } from './panel'; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.test.tsx new file mode 100644 index 0000000000000..cd60fcfc44151 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.test.tsx @@ -0,0 +1,113 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mountWithIntl } from '@kbn/test-jest-helpers'; +import React from 'react'; +import { BaseSnoozePanel } from './base_snooze_panel'; + +describe('CustomRecurrenceScheduler', () => { + test('should render', () => { + const wrapper = mountWithIntl( + + ); + expect(wrapper.find('[data-test-subj="snoozePanel"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="snoozePanelTitle"]').exists()).toBeTruthy(); + expect( + wrapper.find('[data-test-subj="ruleSnoozeIntervalValue"]').first().props().value + ).toEqual(5); + expect(wrapper.find('[data-test-subj="ruleSnoozeIntervalUnit"]').first().props().value).toEqual( + 'd' + ); + expect(wrapper.find('[data-test-subj="ruleSnoozeCancel"]').exists()).toBeFalsy(); + expect(wrapper.find('[data-test-subj="ruleAddSchedule"]').exists()).toBeTruthy(); + }); + test('should render without title', () => { + const wrapper = mountWithIntl( + + ); + expect(wrapper.find('[data-test-subj="snoozePanel"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="snoozePanelTitle"]').exists()).toBeFalsy(); + }); + test('should render with cancel button', () => { + const wrapper = mountWithIntl( + + ); + expect(wrapper.find('[data-test-subj="snoozePanel"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="ruleSnoozeCancel"]').exists()).toBeTruthy(); + }); + test('should render a list of scheduled snoozes', () => { + const wrapper = mountWithIntl( + + ); + expect(wrapper.find('[data-test-subj="snoozePanel"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="ruleAddSchedule"]').exists()).toBeFalsy(); + expect(wrapper.find('[data-test-subj="ruleRemoveAllSchedules"]').exists()).toBeTruthy(); + expect(wrapper.find('[data-test-subj="ruleSchedulesListAddButton"]').exists()).toBeTruthy(); + + expect( + wrapper + .find('[data-test-subj="ruleSchedulesList"]') + .children() + .getElements() + .filter((e) => Boolean(e.key)).length + ).toEqual(2); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.tsx new file mode 100644 index 0000000000000..1453d796a1d39 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/base_snooze_panel.tsx @@ -0,0 +1,404 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { + EuiButton, + EuiButtonEmpty, + EuiConfirmModal, + EuiFieldNumber, + EuiFlexGrid, + EuiFlexGroup, + EuiFlexItem, + EuiHorizontalRule, + EuiIcon, + EuiLink, + EuiPopoverTitle, + EuiSelect, + EuiSpacer, + EuiText, + EuiTitle, + useGeneratedHtmlId, +} from '@elastic/eui'; +import { RuleSnooze } from '@kbn/alerting-plugin/common'; +import moment from 'moment'; +import React, { useState, useCallback, useMemo } from 'react'; +import { parseInterval } from '../../../../../../../common'; + +import { SnoozeSchedule } from '../../../../../../types'; +import { COMMON_SNOOZE_TIMES, SnoozeUnit } from './constants'; +import { durationToTextString, scheduleSummary, usePreviousSnoozeInterval } from './helpers'; +import { DAYS, HOURS, MINUTES, MONTHS, WEEKS } from './translations'; + +export interface BaseSnoozePanelProps { + interval?: string; + snoozeRule: (schedule: SnoozeSchedule) => Promise; + unsnoozeRule: (scheduleIds?: string[]) => Promise; + showCancel: boolean; + scheduledSnoozes: RuleSnooze; + hasTitle?: boolean; + navigateToScheduler: (sched?: SnoozeSchedule) => void; + isLoading: boolean; + onRemoveAllSchedules: (ids: string[]) => void; +} + +export const BaseSnoozePanel: React.FunctionComponent = ({ + isLoading, + interval = '3d', + snoozeRule, + unsnoozeRule, + showCancel, + scheduledSnoozes, + navigateToScheduler, + onRemoveAllSchedules, + hasTitle, +}) => { + const [intervalValue, setIntervalValue] = useState(parseInterval(interval).value); + const [intervalUnit, setIntervalUnit] = useState(parseInterval(interval).unit); + + const [isRemoveAllModalVisible, setIsRemoveAllModalVisible] = useState(false); + + const [previousSnoozeInterval, setPreviousSnoozeInterval] = usePreviousSnoozeInterval(); + + const onChangeValue = useCallback( + ({ target }) => setIntervalValue(target.value), + [setIntervalValue] + ); + const onChangeUnit = useCallback( + ({ target }) => setIntervalUnit(target.value), + [setIntervalUnit] + ); + + const snoozeRuleAndStoreInterval = useCallback( + (newSnoozeEndTime: string | -1, intervalToStore: string | null) => { + if (intervalToStore) { + setPreviousSnoozeInterval(intervalToStore); + } + const newSnoozeSchedule = { + id: null, + duration: newSnoozeEndTime === -1 ? -1 : Date.parse(newSnoozeEndTime) - Date.now(), + rRule: { dtstart: new Date().toISOString(), count: 1, tzid: moment.tz.guess() }, + }; + return snoozeRule(newSnoozeSchedule); + }, + [setPreviousSnoozeInterval, snoozeRule] + ); + + const applySnooze = useCallback( + async (value: number, unit?: SnoozeUnit) => { + if (value === -1) { + await snoozeRuleAndStoreInterval(-1, null); + } else if (value !== 0) { + const newSnoozeEndTime = moment().add(value, unit).toISOString(); + await snoozeRuleAndStoreInterval(newSnoozeEndTime, `${value}${unit}`); + } else await unsnoozeRule(); + }, + [snoozeRuleAndStoreInterval, unsnoozeRule] + ); + + const onApplyIndefinite = useCallback(() => applySnooze(-1), [applySnooze]); + const onClickApplyButton = useCallback( + () => applySnooze(intervalValue, intervalUnit as SnoozeUnit), + [applySnooze, intervalValue, intervalUnit] + ); + const onCancelSnooze = useCallback(() => applySnooze(0, 'm'), [applySnooze]); + + const onClickAddSchedule = useCallback(() => navigateToScheduler(), [navigateToScheduler]); + const onClickEditScheduleFactory = useCallback( + (schedule: SnoozeSchedule) => () => navigateToScheduler(schedule), + [navigateToScheduler] + ); + + const onClickRemoveAllSchedules = useCallback(() => { + setIsRemoveAllModalVisible(false); + onRemoveAllSchedules(scheduledSnoozes!.filter((s) => s.id).map((s) => s.id as string)); + }, [onRemoveAllSchedules, scheduledSnoozes]); + + const hasSchedules = useMemo( + () => scheduledSnoozes && scheduledSnoozes.filter((s) => Boolean(s.id)).length > 0, + [scheduledSnoozes] + ); + + const parsedPrevSnooze = previousSnoozeInterval ? parseInterval(previousSnoozeInterval) : null; + const prevSnoozeEqualsCurrentSnooze = + parsedPrevSnooze?.value === intervalValue && parsedPrevSnooze?.unit === intervalUnit; + const previousButton = parsedPrevSnooze && !prevSnoozeEqualsCurrentSnooze && ( + <> + + + applySnooze(parsedPrevSnooze.value, parsedPrevSnooze.unit as SnoozeUnit)} + > + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.previousSnooze', { + defaultMessage: 'Previous', + })} + + + + + {durationToTextString(parsedPrevSnooze.value, parsedPrevSnooze.unit as SnoozeUnit)} + + + + + + ); + return ( + <> + {hasTitle && ( + + + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozePanelTitle', { + defaultMessage: 'Snooze notifications', + })} + + + + )} + + + + + + + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.applySnooze', { + defaultMessage: 'Apply', + })} + + + + + {previousButton} + + + +
+ {i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeCommonlyUsed', { + defaultMessage: 'Commonly used', + })} +
+ + + + {COMMON_SNOOZE_TIMES.map(([value, unit]) => ( + + applySnooze(value, unit)} + > + {durationToTextString(value, unit)} + + + ))} + + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeIndefinitely', { + defaultMessage: 'Snooze indefinitely', + })} + + + + + {!hasSchedules && ( + <> + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.addSchedule', { + defaultMessage: 'Add schedule', + })} + + + + + + + {i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.addScheduleDescription', + { + defaultMessage: + 'Create recurring schedules to silence actions during expected downtimes', + } + )} + + + + + )} + {hasSchedules && ( + <> + + + +
+ {i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.snoozeSchedulesTitle', + { + defaultMessage: 'Schedules', + } + )} +
+ + + + setIsRemoveAllModalVisible(true)} + data-test-subj="ruleRemoveAllSchedules" + > + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.removeAllButton', { + defaultMessage: 'Remove all', + })} + + + + + {scheduledSnoozes!.map((schedule) => ( + + + + ))} + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.addButton', { + defaultMessage: 'Add', + })} + + + + + )} + {showCancel && ( + <> + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.cancelSnooze', { + defaultMessage: 'Cancel snooze', + })} + + + + + )} + + {isRemoveAllModalVisible && ( + setIsRemoveAllModalVisible(false)} + onConfirm={onClickRemoveAllSchedules} + buttonColor="danger" + cancelButtonText={i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.removeCancelButton', + { + defaultMessage: 'Cancel', + } + )} + confirmButtonText={i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.removeConfirmButton', + { + defaultMessage: 'Remove all', + } + )} + > + + {i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.removeAllSnoozeSchedulesConfirmText', + { + defaultMessage: + 'This will remove {count, plural, one {# scheduled snooze} other {# scheduled snoozes}} from this rule. Are you sure?', + values: { count: scheduledSnoozes?.length ?? 0 }, + } + )} + + + )} + + ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/constants.ts b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/constants.ts new file mode 100644 index 0000000000000..8e12e15f619ff --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/constants.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export type SnoozeUnit = 'm' | 'h' | 'd' | 'w' | 'M'; +export const COMMON_SNOOZE_TIMES: Array<[number, SnoozeUnit]> = [ + [1, 'h'], + [3, 'h'], + [8, 'h'], + [1, 'd'], +]; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.test.tsx new file mode 100644 index 0000000000000..343db5adbad97 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.test.tsx @@ -0,0 +1,75 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import sinon from 'sinon'; +import { RRuleFrequency } from '../../../../../../types'; +import { futureTimeToInterval, durationToTextString, scheduleSummary } from './helpers'; + +const NOW = '2021-01-01T12:00:00.000Z'; +const TEN_MINUTES_FROM_NOW = '2021-01-01T12:10:00.000Z'; +const ABOUT_ONE_HOUR_FROM_NOW = '2021-01-01T13:10:00.000Z'; +const TWO_DAYS_FROM_NOW = '2021-01-03T10:10:00.000Z'; +const SIX_MONTHS_FROM_NOW = '2021-07-03T10:10:00.000Z'; +const THIRTY_SIX_MONTHS_FROM_NOW = '2023-07-03T10:10:00.000Z'; + +describe('Snooze panel helpers', () => { + let timers: sinon.SinonFakeTimers; + + beforeAll(() => { + timers = sinon.useFakeTimers(new Date(NOW)); + }); + afterAll(() => { + timers.restore(); + }); + + describe('futureTimeToInterval', () => { + test('should parse a time several minutes from now', () => { + expect(futureTimeToInterval(new Date(TEN_MINUTES_FROM_NOW))).toBe('10m'); + }); + test('should parse a time about an hour from now', () => { + expect(futureTimeToInterval(new Date(ABOUT_ONE_HOUR_FROM_NOW))).toBe('1h'); + }); + test('should parse a time days from now', () => { + expect(futureTimeToInterval(new Date(TWO_DAYS_FROM_NOW))).toBe('2d'); + }); + test('should parse a time months from now', () => { + expect(futureTimeToInterval(new Date(SIX_MONTHS_FROM_NOW))).toBe('6M'); + }); + test('should parse a time years from now', () => { + expect(futureTimeToInterval(new Date(THIRTY_SIX_MONTHS_FROM_NOW))).toBe('36M'); + }); + }); + + describe('durationToTextString', () => { + test('should output 1 hour instead of "an" hour', () => { + expect(durationToTextString(1, 'h')).toBe('1 hour'); + }); + + test('should output 2 days', () => { + expect(durationToTextString(2, 'd')).toBe('2 days'); + }); + }); + + describe('scheduleSummary', () => { + test('should capitalize the output', () => { + expect( + scheduleSummary({ + id: null, + duration: 864000, + rRule: { + dtstart: NOW, + tzid: 'UTC', + freq: RRuleFrequency.MONTHLY, + interval: 1, + count: 5, + byweekday: ['+4TU'], + }, + }) + ).toEqual('Every month on the 4th Tuesday for 5 occurrences'); + }); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.tsx new file mode 100644 index 0000000000000..b31991b14ad9b --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/helpers.tsx @@ -0,0 +1,81 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import moment from 'moment'; +import { useState } from 'react'; + +import { RecurrenceSchedule, SnoozeSchedule } from '../../../../../../types'; +import { recurrenceSummary } from '../recurrence_scheduler/helpers'; +import { SnoozeUnit } from './constants'; +import { ONE } from './translations'; + +const PREV_SNOOZE_INTERVAL_KEY = 'triggersActionsUi_previousSnoozeInterval'; +export const usePreviousSnoozeInterval: ( + p?: string | null +) => [string | null, (n: string) => void] = (propsInterval) => { + const intervalFromStorage = localStorage.getItem(PREV_SNOOZE_INTERVAL_KEY); + const usePropsInterval = typeof propsInterval !== 'undefined'; + const interval = usePropsInterval ? propsInterval : intervalFromStorage; + const [previousSnoozeInterval, setPreviousSnoozeInterval] = useState(interval); + const storeAndSetPreviousSnoozeInterval = (newInterval: string) => { + if (!usePropsInterval) { + localStorage.setItem(PREV_SNOOZE_INTERVAL_KEY, newInterval); + } + setPreviousSnoozeInterval(newInterval); + }; + return [previousSnoozeInterval, storeAndSetPreviousSnoozeInterval]; +}; + +export const futureTimeToInterval = (time?: Date | null) => { + if (!time) return; + const relativeTime = moment(time).locale('en').fromNow(true); + const [valueStr, unitStr] = relativeTime.split(' '); + let value = valueStr === 'a' || valueStr === 'an' ? 1 : parseInt(valueStr, 10); + let unit; + switch (unitStr) { + case 'year': + case 'years': + unit = 'M'; + value = value * 12; + break; + case 'month': + case 'months': + unit = 'M'; + break; + case 'day': + case 'days': + unit = 'd'; + break; + case 'hour': + case 'hours': + unit = 'h'; + break; + case 'minute': + case 'minutes': + unit = 'm'; + break; + } + + if (!unit) return; + return `${value}${unit}`; +}; + +export const durationToTextString = (value: number, unit: SnoozeUnit) => { + // Moment.humanize will parse "1" as "a" or "an", e.g "an hour" + // Override this to output "1 hour" + if (value === 1) { + return ONE[unit]; + } + return moment.duration(value, unit).humanize(); +}; + +export const scheduleSummary = (schedule: SnoozeSchedule) => { + if (schedule.rRule.freq == null) return moment(schedule.rRule.dtstart).format('LLLL'); + const summary = recurrenceSummary(schedule.rRule as RecurrenceSchedule); + // Capitalize first letter of summary + return summary[0].toLocaleUpperCase() + summary.slice(1); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/index.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/index.tsx new file mode 100644 index 0000000000000..7a5965532e4cf --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/index.tsx @@ -0,0 +1,115 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useCallback, useState } from 'react'; +import { SnoozeSchedule } from '../../../../../../types'; +import { RuleSnoozeScheduler } from '../scheduler'; +import { BaseSnoozePanel, BaseSnoozePanelProps } from './base_snooze_panel'; + +export { futureTimeToInterval } from './helpers'; + +type SnoozePanelProps = Pick< + BaseSnoozePanelProps, + 'interval' | 'snoozeRule' | 'unsnoozeRule' | 'showCancel' | 'scheduledSnoozes' | 'hasTitle' +>; + +export const SnoozePanel: React.FC = ({ + interval, + snoozeRule, + unsnoozeRule, + showCancel, + scheduledSnoozes, + hasTitle = true, +}) => { + const [isSchedulerOpen, setIsSchedulerOpen] = useState(false); + const [initialSchedule, setInitialSchedule] = useState(null); + const [isLoading, setIsLoading] = useState(false); + + const onSnoozeRule = useCallback( + async (schedule: SnoozeSchedule) => { + setIsLoading(true); + try { + await snoozeRule(schedule); + } finally { + setIsLoading(false); + } + }, + [setIsLoading, snoozeRule] + ); + + const onUnsnoozeRule = useCallback( + async (scheduleIds?: string[]) => { + setIsLoading(true); + try { + await unsnoozeRule(scheduleIds); + } finally { + setIsLoading(false); + } + }, + [setIsLoading, unsnoozeRule] + ); + + const saveSnoozeSchedule = useCallback( + async (schedule: SnoozeSchedule) => { + setIsLoading(true); + try { + await snoozeRule(schedule); + } finally { + setIsLoading(false); + } + }, + [snoozeRule, setIsLoading] + ); + + const cancelSnoozeSchedules = useCallback( + async (scheduleIds: string[]) => { + setIsLoading(true); + try { + await unsnoozeRule(scheduleIds); + } finally { + setIsLoading(false); + } + }, + [unsnoozeRule, setIsLoading] + ); + + const onOpenScheduler = useCallback( + (schedule?: SnoozeSchedule) => { + setInitialSchedule(schedule ?? null); + setIsSchedulerOpen(true); + }, + [setInitialSchedule, setIsSchedulerOpen] + ); + + const onCloseScheduler = useCallback(() => setIsSchedulerOpen(false), [setIsSchedulerOpen]); + + return !isSchedulerOpen ? ( + + ) : ( + + ); +}; + +// eslint-disable-next-line import/no-default-export +export { SnoozePanel as default }; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/translations.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/translations.tsx new file mode 100644 index 0000000000000..71c16175401ed --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/panel/translations.tsx @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { SnoozeUnit } from './constants'; + +export const MINUTES = i18n.translate('xpack.triggersActionsUI.sections.rulesList.minutesLabel', { + defaultMessage: 'minutes', +}); +export const HOURS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.hoursLabel', { + defaultMessage: 'hours', +}); +export const DAYS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.daysLabel', { + defaultMessage: 'days', +}); +export const WEEKS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.weeksLabel', { + defaultMessage: 'weeks', +}); +export const MONTHS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.monthsLabel', { + defaultMessage: 'months', +}); + +// i18n constants to override moment.humanize +export const ONE: Record = { + m: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneMinute', { + defaultMessage: '1 minute', + }), + h: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneHour', { + defaultMessage: '1 hour', + }), + d: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneDay', { + defaultMessage: '1 day', + }), + w: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneWeek', { + defaultMessage: '1 week', + }), + M: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneMonth', { + defaultMessage: '1 month', + }), +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/constants.ts b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/constants.ts new file mode 100644 index 0000000000000..72a78dc964225 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/constants.ts @@ -0,0 +1,85 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { i18n } from '@kbn/i18n'; +import { invert, mapValues } from 'lodash'; +import moment from 'moment'; +import { RRuleFrequency } from '../../../../../../types'; + +export const ISO_WEEKDAYS = [1, 2, 3, 4, 5, 6, 7]; + +export const RECURRENCE_END_OPTIONS = [ + { id: 'never', label: 'Never' }, + { id: 'ondate', label: 'On date' }, + { id: 'afterx', label: 'After {x}' }, +]; + +export const DEFAULT_REPEAT_OPTIONS = [ + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurDaily', { + defaultMessage: 'Daily', + }), + value: RRuleFrequency.DAILY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurWeekly', { + defaultMessage: 'Weekly', + }), + value: RRuleFrequency.WEEKLY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurMonthly', { + defaultMessage: 'Monthly', + }), + value: RRuleFrequency.MONTHLY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurYearly', { + defaultMessage: 'Yearly', + }), + value: RRuleFrequency.YEARLY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurCustom', { + defaultMessage: 'Custom', + }), + value: 'CUSTOM', + }, +]; + +export const DEFAULT_RRULE_PRESETS = { + [RRuleFrequency.DAILY]: { + interval: 1, + }, + [RRuleFrequency.WEEKLY]: { + interval: 1, + }, + [RRuleFrequency.MONTHLY]: { + interval: 1, + }, + [RRuleFrequency.YEARLY]: { + interval: 1, + }, +}; + +export const I18N_WEEKDAY_OPTIONS = ISO_WEEKDAYS.map((n) => ({ + id: String(n), + label: moment().isoWeekday(n).format('dd'), +})); + +export const ISO_WEEKDAYS_TO_RRULE: Record = { + 1: 'MO', + 2: 'TU', + 3: 'WE', + 4: 'TH', + 5: 'FR', + 6: 'SA', + 7: 'SU', +}; + +export const RRULE_WEEKDAYS_TO_ISO_WEEKDAYS = mapValues(invert(ISO_WEEKDAYS_TO_RRULE), (v) => + Number(v) +); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.test.tsx new file mode 100644 index 0000000000000..25c91004ac77e --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.test.tsx @@ -0,0 +1,92 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mountWithIntl } from '@kbn/test-jest-helpers'; +import moment from 'moment'; +import React from 'react'; +import { RRuleFrequency } from '../../../../../../types'; +import { CustomRecurrenceScheduler } from './custom_recurrence_scheduler'; + +describe('CustomRecurrenceScheduler', () => { + const startDate = moment('11/23/1979'); + const initialState = { + freq: RRuleFrequency.DAILY, + interval: 1, + byweekday: [], + bymonthday: [], + bymonth: [], + }; + const onChange = jest.fn(); + + beforeEach(() => { + onChange.mockReset(); + }); + + test('render', () => { + const wrapper = mountWithIntl( + + ); + expect(wrapper.find('[data-test-subj="customRecurrenceScheduler"]').exists()).toBeTruthy(); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerFrequency"]').first().props().value + ).toEqual(RRuleFrequency.DAILY); + expect(wrapper.find('[data-test-subj="customRecurrenceSchedulerWeekly"]').exists()).toBeFalsy(); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerMonthly"]').exists() + ).toBeFalsy(); + }); + + test('render weekly options', () => { + const wrapper = mountWithIntl( + + ); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerWeekly"]').exists() + ).toBeTruthy(); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerFrequency"]').first().props().value + ).toEqual(RRuleFrequency.WEEKLY); + }); + + test('render monthly options', () => { + const wrapper = mountWithIntl( + + ); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerMonthly"]').exists() + ).toBeTruthy(); + expect( + wrapper.find('[data-test-subj="customRecurrenceSchedulerFrequency"]').first().props().value + ).toEqual(RRuleFrequency.MONTHLY); + }); + + test('should call onChange when state changed ', () => { + const wrapper = mountWithIntl( + + ); + + wrapper.find('[data-test-subj="customRecurrenceSchedulerFrequency"]').first().simulate('click'); + wrapper.find('option[data-test-subj="ruleSnoozeSchedulerRecurWeek"]').first().simulate('click'); + expect(onChange).toHaveBeenCalled(); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.tsx new file mode 100644 index 0000000000000..84af76cc3cf57 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/custom_recurrence_scheduler.tsx @@ -0,0 +1,186 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + EuiButtonGroup, + EuiFieldNumber, + EuiFormControlLayoutDelimited, + EuiFormRow, + EuiSelect, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { euiStyled } from '@kbn/kibana-react-plugin/common'; +import deepEqual from 'fast-deep-equal'; +import { Moment } from 'moment'; +import React, { useCallback, useEffect, useMemo, useState, useRef } from 'react'; + +import { RRuleFrequency } from '../../../../../../types'; +import { I18N_WEEKDAY_OPTIONS } from './constants'; +import { + buildCustomRecurrenceSchedulerState, + CustomFrequencyState, + getInitialByweekday, + getWeekdayInfo, +} from './helpers'; +import { i18nEndControlOptions, i18nNthWeekdayShort } from './translations'; + +// FIXME https://github.com/elastic/eui/issues/5958 +const EuiFormRowWithDelimitedFixer = euiStyled(EuiFormRow)` + & .euiFormControlLayout__childrenWrapper { + height: 100%; + } +`; + +interface CustomRecurrenceSchedulerProps { + startDate: Moment | null; + onChange: (state: CustomFrequencyState) => void; + initialState: CustomFrequencyState; +} + +export const CustomRecurrenceScheduler: React.FC = ({ + startDate, + onChange, + initialState, +}) => { + const [initialStartDate] = useState(startDate); + const [frequency, setFrequency] = useState(initialState.freq); + const [interval, setInterval] = useState(initialState.interval); + const [byweekday, setByweekday] = useState( + getInitialByweekday(initialState.byweekday, startDate) + ); + const [monthlyRecurDay, setMonthlyRecurDay] = useState( + initialState.freq === RRuleFrequency.MONTHLY && initialState.byweekday.length > 0 + ? 'weekday' + : 'day' + ); + + const monthlyRecurDayOptions = useMemo(() => { + if (!startDate) return []; + const { dayOfWeek, nthWeekdayOfMonth, isLastOfMonth } = getWeekdayInfo(startDate); + return [ + { + id: 'day', + label: i18n.translate( + 'xpack.triggersActionsUI.ruleSnoozeScheduler.repeatOnMonthlyDayNumber', + { + defaultMessage: 'On day {dayNumber}', + values: { dayNumber: startDate.date() }, + } + ), + }, + { + id: 'weekday', + label: i18nNthWeekdayShort(dayOfWeek!)[isLastOfMonth ? 0 : nthWeekdayOfMonth!], + }, + ]; + }, [startDate]); + + useEffect(() => { + if (initialStartDate !== startDate) setByweekday(getInitialByweekday([], startDate)); + }, [startDate, initialStartDate]); + + const customRecurrenceSchedulerState = useRef(null); + useEffect(() => { + const nextState = buildCustomRecurrenceSchedulerState({ + frequency, + interval, + byweekday, + monthlyRecurDay, + startDate, + }); + if (!deepEqual(customRecurrenceSchedulerState.current, nextState)) { + onChange(nextState); + customRecurrenceSchedulerState.current = nextState; + } + }, [frequency, interval, byweekday, monthlyRecurDay, startDate, onChange]); + + const onToggleWeekday = useCallback( + (id: string) => { + const newByweekday = { ...byweekday, [id]: !byweekday[id as keyof typeof byweekday] }; + // Don't allow the user to deselect all weekdays + if (!Object.values(newByweekday).every((v) => v === false)) { + setByweekday(newByweekday); + } + }, + [byweekday] + ); + + const endControlOptions = useMemo(() => i18nEndControlOptions(interval), [interval]); + + return ( + <> + + setInterval(Number(e.target.value))} + /> + } + endControl={ + setFrequency(Number(e.target.value))} + value={frequency} + options={endControlOptions} + /> + } + /> + + {frequency === RRuleFrequency.WEEKLY && ( + + + + )} + {frequency === RRuleFrequency.MONTHLY && startDate && ( + + + + )} + + ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.test.tsx new file mode 100644 index 0000000000000..eb5ad5bf64510 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.test.tsx @@ -0,0 +1,291 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import moment from 'moment'; +import { RRuleFrequency } from '../../../../../../types'; +import { + buildCustomRecurrenceSchedulerState, + generateNthByweekday, + getInitialByweekday, + getWeekdayInfo, + recurrenceSummary, + rRuleWeekdayToWeekdayName, +} from './helpers'; + +describe('Recurrence scheduler helper', () => { + describe('getWeekdayInfo', () => { + test('should return the fourth tuesday of the month for 11/23/2021', () => { + expect(getWeekdayInfo(moment('11/23/2021'))).toEqual({ + dayOfWeek: 'Tuesday', + isLastOfMonth: false, + nthWeekdayOfMonth: 4, + }); + }); + + test('should return the third Tuesday of the month 11/16/2021', () => { + expect(getWeekdayInfo(moment('11/16/2021'))).toEqual({ + dayOfWeek: 'Tuesday', + isLastOfMonth: false, + nthWeekdayOfMonth: 3, + }); + }); + + test('should return the last Friday of the month 12/25/2020', () => { + expect(getWeekdayInfo(moment('12/25/2020'))).toEqual({ + dayOfWeek: 'Friday', + isLastOfMonth: true, + nthWeekdayOfMonth: 4, + }); + }); + + test('should return expected invalid props for a null date', () => { + expect(getWeekdayInfo(moment(null))).toEqual({ + dayOfWeek: 'Invalid date', + isLastOfMonth: true, + nthWeekdayOfMonth: NaN, + }); + }); + }); + + describe('getInitialByweekday', () => { + test('when passed empty recurrence params, should return the day of the week of the passed in startDate', () => { + expect(getInitialByweekday([], moment('11/23/2021'))).toEqual({ + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }); + }); + + test('when passed recurrence params, should return the passed in days of the week and ignore the startDate', () => { + expect(getInitialByweekday(['+2MO', '-1FR'], moment('11/23/2021'))).toEqual({ + '1': true, + '2': false, + '3': false, + '4': false, + '5': true, + '6': false, + '7': false, + }); + }); + + test('when passed a null date, should return only Monday', () => { + expect(getInitialByweekday([], null)).toEqual({ + '1': true, + '2': false, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }); + }); + }); + + describe('generateNthByweekday', () => { + test('should parse the 4th tuesday', () => { + expect(generateNthByweekday(moment('11/23/2021'))).toEqual(['+4TU']); + }); + + test('should parse the 3rd tuesday', () => { + expect(generateNthByweekday(moment('11/16/2021'))).toEqual(['+3TU']); + }); + }); + + describe('recurrenceSummary', () => { + test('should give a detailed msg with the until', () => { + expect( + recurrenceSummary({ + freq: RRuleFrequency.MONTHLY, + interval: 1, + until: moment('11/23/1979'), + count: 5, + byweekday: ['+4TU'], + }) + ).toEqual('every month on the 4th Tuesday until November 23, 1979'); + }); + + test('should give a detailed msg with the occurrences', () => { + expect( + recurrenceSummary({ + freq: RRuleFrequency.MONTHLY, + interval: 1, + count: 5, + byweekday: ['+4TU'], + }) + ).toEqual('every month on the 4th Tuesday for 5 occurrences'); + }); + + test('should give a detailed msg with the recurrence', () => { + expect( + recurrenceSummary({ + freq: RRuleFrequency.MONTHLY, + interval: 1, + byweekday: ['+4TU'], + }) + ).toEqual('every month on the 4th Tuesday'); + }); + + test('should give a basic msg', () => { + expect( + recurrenceSummary({ + freq: RRuleFrequency.MONTHLY, + interval: 1, + }) + ).toEqual('every month'); + }); + }); + + describe('rRuleWeekdayToWeekdayName', () => { + test('parses 2nd Monday', () => { + expect(rRuleWeekdayToWeekdayName('+2MO')).toEqual('Monday'); + }); + + test('parses 3rd Tuesday', () => { + expect(rRuleWeekdayToWeekdayName('+3TU')).toEqual('Tuesday'); + }); + + test('parses last Friday', () => { + expect(rRuleWeekdayToWeekdayName('-1FR')).toEqual('Friday'); + }); + }); + + describe('buildCustomRecurrenceSchedulerState', () => { + test('Daily frequency ', () => { + expect( + buildCustomRecurrenceSchedulerState({ + frequency: RRuleFrequency.DAILY, + interval: 2, + byweekday: { + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }, + monthlyRecurDay: 'day', + startDate: moment('11/23/2021'), + }) + ).toEqual({ + bymonth: [], + bymonthday: [], + byweekday: [], + freq: 3, + interval: 2, + }); + }); + + test('Weekly frequency ', () => { + expect( + buildCustomRecurrenceSchedulerState({ + frequency: RRuleFrequency.WEEKLY, + interval: 2, + byweekday: { + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }, + monthlyRecurDay: 'day', + startDate: moment('11/23/2021'), + }) + ).toEqual({ + bymonth: [], + bymonthday: [], + byweekday: ['TU'], + freq: 2, + interval: 2, + }); + }); + + test('Monthly frequency ', () => { + expect( + buildCustomRecurrenceSchedulerState({ + frequency: RRuleFrequency.MONTHLY, + interval: 2, + byweekday: { + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }, + monthlyRecurDay: 'day', + startDate: moment('11/23/2021'), + }) + ).toEqual({ + bymonth: [], + bymonthday: [23], + byweekday: [], + freq: 1, + interval: 2, + }); + }); + + test('Monthly frequency by weekday ', () => { + expect( + buildCustomRecurrenceSchedulerState({ + frequency: RRuleFrequency.MONTHLY, + interval: 2, + byweekday: { + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }, + monthlyRecurDay: 'weekday', + startDate: moment('11/23/2021'), + }) + ).toEqual({ + bymonth: [], + bymonthday: [], + byweekday: ['+4TU'], + freq: 1, + interval: 2, + }); + }); + + test('Yearly frequency ', () => { + expect( + buildCustomRecurrenceSchedulerState({ + frequency: RRuleFrequency.YEARLY, + interval: 2, + byweekday: { + '1': false, + '2': true, + '3': false, + '4': false, + '5': false, + '6': false, + '7': false, + }, + monthlyRecurDay: 'day', + startDate: moment('11/23/2021'), + }) + ).toEqual({ + bymonth: [10], + bymonthday: [23], + byweekday: [], + freq: 0, + interval: 2, + }); + }); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.tsx new file mode 100644 index 0000000000000..e8d272eb85ae6 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.tsx @@ -0,0 +1,189 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import moment, { Moment } from 'moment'; + +import { RecurrenceSchedule, RRuleFrequency } from '../../../../../../types'; +import { i18nMonthDayDate } from '../../../../../lib/i18n_month_day_date'; +import { ISO_WEEKDAYS, ISO_WEEKDAYS_TO_RRULE, RRULE_WEEKDAYS_TO_ISO_WEEKDAYS } from './constants'; +import { i18nFreqSummary, i18nNthWeekdayShort } from './translations'; + +export interface CustomFrequencyState { + freq: RRuleFrequency; + interval: number; + byweekday: string[]; + bymonthday: number[]; + bymonth: number[]; +} + +export const getWeekdayInfo = (date: Moment) => { + const dayOfWeek = date.format('dddd'); + const nthWeekdayOfMonth = Math.ceil(date.date() / 7); + const isLastOfMonth = nthWeekdayOfMonth > 4 || !date.isSame(moment(date).add(7, 'd'), 'month'); + return { dayOfWeek, nthWeekdayOfMonth, isLastOfMonth }; +}; + +export const getInitialByweekday = ( + initialStateByweekday: CustomFrequencyState['byweekday'], + date: Moment | null +) => { + const dayOfWeek = date ? date.isoWeekday() : 1; + return ISO_WEEKDAYS.reduce( + (result, n) => ({ + ...result, + [n]: + initialStateByweekday.length > 0 + ? initialStateByweekday + // Sanitize nth day strings, e.g. +2MO, -1FR, into just days of the week + .map((w) => w.replace(/[0-9+\-]/g, '')) + .includes(ISO_WEEKDAYS_TO_RRULE[n]) + : n === dayOfWeek, + }), + {} as Record + ); +}; + +export const generateNthByweekday = (startDate: Moment) => { + const { isLastOfMonth, nthWeekdayOfMonth } = getWeekdayInfo(startDate); + return [ + `${isLastOfMonth ? '-1' : '+' + nthWeekdayOfMonth}${ + ISO_WEEKDAYS_TO_RRULE[startDate.isoWeekday()] + }`, + ]; +}; + +export const recurrenceSummary = ({ + freq, + interval, + until, + count, + byweekday, + bymonthday, + bymonth, +}: RecurrenceSchedule) => { + const frequencySummary = i18nFreqSummary(interval)[freq]; + + // For weekday summaries + const firstWeekday = byweekday ? byweekday[0] : ''; + const nthWeekday = !firstWeekday + ? null + : firstWeekday.startsWith('+') + ? Number(firstWeekday[1]) + : firstWeekday.startsWith('-1') + ? 0 + : null; + let byweekdaySummary = + byweekday && byweekday.length > 0 + ? nthWeekday !== null + ? i18nNthWeekdayShort(rRuleWeekdayToWeekdayName(firstWeekday))[nthWeekday] + : i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.byweekdaySummary', { + defaultMessage: 'on {weekdays}', + values: { + weekdays: byweekday + .map((rRuleWeekday) => rRuleWeekdayToWeekdayName(rRuleWeekday)) + .join(', '), + }, + }) + : null; + if (byweekdaySummary) + byweekdaySummary = byweekdaySummary[0].toLocaleLowerCase() + byweekdaySummary.slice(1); + + const bymonthdaySummary = + bymonthday && bymonthday.length > 0 + ? i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.bymonthdaySummary', { + defaultMessage: 'on day {monthday}', + values: { + monthday: bymonthday.join(', '), + }, + }) + : null; + + const bymonthSummary = + bymonth && bymonth.length > 0 && bymonthday && bymonthday.length > 0 + ? i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.bymonthSummary', { + defaultMessage: 'on {date}', + values: { + date: i18nMonthDayDate(moment().month(bymonth[0]).date(bymonthday[0])), + }, + }) + : null; + + const onSummary = + freq === RRuleFrequency.WEEKLY + ? byweekdaySummary + : freq === RRuleFrequency.MONTHLY + ? byweekdaySummary ?? bymonthdaySummary + : freq === RRuleFrequency.YEARLY + ? bymonthSummary + : null; + + const untilSummary = until + ? i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.untilDateSummary', { + defaultMessage: 'until {date}', + values: { date: moment(until).format('LL') }, + }) + : count + ? i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.occurrencesSummary', { + defaultMessage: 'for {count, plural, one {# occurrence} other {# occurrences}}', + values: { count }, + }) + : null; + + const every = i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurrenceSummary', { + defaultMessage: 'every {frequencySummary}{on}{until}', + values: { + frequencySummary, + on: onSummary ? ` ${onSummary}` : '', + until: untilSummary ? ` ${untilSummary}` : '', + }, + }); + + return every; +}; + +export const rRuleWeekdayToWeekdayName = (weekday: string) => + moment().isoWeekday(RRULE_WEEKDAYS_TO_ISO_WEEKDAYS[weekday.slice(-2)]).format('dddd'); + +export const buildCustomRecurrenceSchedulerState = ({ + frequency, + interval, + byweekday, + monthlyRecurDay, + startDate, +}: { + frequency: RRuleFrequency; + interval: number; + byweekday: Record; + monthlyRecurDay: string; + startDate: Moment | null; +}) => { + const isMonthlyByDay = frequency === RRuleFrequency.MONTHLY && monthlyRecurDay === 'day'; + const isMonthlyByWeekday = frequency === RRuleFrequency.MONTHLY && monthlyRecurDay === 'weekday'; + const useByMonthDay = startDate && (isMonthlyByDay || frequency === RRuleFrequency.YEARLY); + + const configuredByweekday = + // If weekly frequency is selected, pull byweekday from chosen days + frequency === RRuleFrequency.WEEKLY + ? Object.keys(byweekday) + .filter((k) => byweekday[k] === true) + .map((n) => ISO_WEEKDAYS_TO_RRULE[Number(n)]) + : // If monthly frequency is selected with the nth weekday option, pull byweekday from the configured startDate + startDate && isMonthlyByWeekday + ? generateNthByweekday(startDate) + : []; + + const bymonthday = useByMonthDay ? [startDate.date()] : []; + const bymonth = startDate && frequency === RRuleFrequency.YEARLY ? [startDate.month()] : []; + return { + freq: frequency, + interval, + byweekday: configuredByweekday, + bymonthday, + bymonth, + }; +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/index.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/index.tsx new file mode 100644 index 0000000000000..4b2bc6e70d71e --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/index.tsx @@ -0,0 +1,290 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + EuiButtonGroup, + EuiDatePicker, + EuiFieldNumber, + EuiFormControlLayout, + EuiFormRow, + EuiHorizontalRule, + EuiPanel, + EuiSelect, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import moment from 'moment'; +import { Moment } from 'moment'; +import React from 'react'; +import { useEffect, useMemo, useRef, useState } from 'react'; + +import { RRuleFrequency, RecurrenceSchedule } from '../../../../../../types'; +import { i18nMonthDayDate } from '../../../../../lib/i18n_month_day_date'; +import { + DEFAULT_REPEAT_OPTIONS, + DEFAULT_RRULE_PRESETS, + ISO_WEEKDAYS_TO_RRULE, + RECURRENCE_END_OPTIONS, +} from './constants'; +import { CustomRecurrenceScheduler } from './custom_recurrence_scheduler'; +import { + CustomFrequencyState, + generateNthByweekday, + getWeekdayInfo, + recurrenceSummary, +} from './helpers'; +import { i18nNthWeekday } from './translations'; + +interface ComponentOpts { + startDate: Moment | null; + endDate: Moment | null; + initialState: RecurrenceSchedule | null; + onChange: (schedule: RecurrenceSchedule) => void; +} + +export const RecurrenceScheduler: React.FC = ({ + startDate, + endDate, + onChange, + initialState, +}) => { + const hasInitialized = useRef(false); + const [frequency, setFrequency] = useState(RRuleFrequency.DAILY); + const [recurrenceEnds, setRecurrenceEnds] = useState('never'); + + const [customFrequency, setCustomFrequency] = useState({ + freq: RRuleFrequency.DAILY, + interval: 1, + byweekday: [], + bymonthday: [], + bymonth: [], + }); + + const [recurrenceEndDate, setRecurrenceEndDate] = useState(endDate); + const [occurrences, setOccurrrences] = useState(1); + + const disableDailyOption = useMemo(() => { + if (!startDate || !endDate) return false; + return Math.abs(startDate.diff(endDate, 'hours')) >= 24; + }, [startDate, endDate]); + + useEffect(() => { + if (disableDailyOption && frequency === RRuleFrequency.DAILY) + setFrequency(RRuleFrequency.WEEKLY); + }, [disableDailyOption, frequency]); + + useEffect(() => { + if (initialState && !hasInitialized.current) { + const isCustomFrequency = + initialState.interval > 1 || (initialState.byweekday ?? []).length > 1; + setFrequency(isCustomFrequency ? 'CUSTOM' : initialState.freq); + if (isCustomFrequency) { + setCustomFrequency(initialState as CustomFrequencyState); + } + if (initialState.until) { + setRecurrenceEnds('ondate'); + setRecurrenceEndDate(initialState.until); + } + if (initialState.count) { + setRecurrenceEnds('afterx'); + setOccurrrences(initialState.count); + } + } + hasInitialized.current = true; + }, [initialState]); + + const { repeatOptions, rrulePresets } = useMemo(() => { + if (!startDate) { + return { + repeatOptions: DEFAULT_REPEAT_OPTIONS, + rrulePresets: DEFAULT_RRULE_PRESETS, + }; + } + const { dayOfWeek, nthWeekdayOfMonth, isLastOfMonth } = getWeekdayInfo(startDate); + return { + repeatOptions: [ + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurDaily', { + defaultMessage: 'Daily', + }), + value: RRuleFrequency.DAILY, + disabled: disableDailyOption, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurWeeklyOnWeekday', { + defaultMessage: 'Weekly on {dayOfWeek}', + values: { dayOfWeek }, + }), + value: RRuleFrequency.WEEKLY, + }, + { + text: i18nNthWeekday(dayOfWeek)[isLastOfMonth ? 0 : nthWeekdayOfMonth], + value: RRuleFrequency.MONTHLY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurYearlyOnDay', { + defaultMessage: 'Yearly on {date}', + values: { + date: i18nMonthDayDate(startDate), + }, + }), + value: RRuleFrequency.YEARLY, + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurCustom', { + defaultMessage: 'Custom', + }), + value: 'CUSTOM', + }, + ], + rrulePresets: { + [RRuleFrequency.DAILY]: { + interval: 1, + }, + [RRuleFrequency.WEEKLY]: { + interval: 1, + byweekday: [ISO_WEEKDAYS_TO_RRULE[startDate.isoWeekday()]], + }, + [RRuleFrequency.MONTHLY]: { + interval: 1, + byweekday: generateNthByweekday(startDate), + }, + [RRuleFrequency.YEARLY]: { + interval: 1, + bymonth: [startDate.month() + 1], + bymonthday: [startDate.date()], + }, + }, + }; + }, [startDate, disableDailyOption]); + + const compiledRecurrenceSchedule: RecurrenceSchedule = useMemo(() => { + const recurrenceEndProps = + recurrenceEnds === 'ondate' && recurrenceEndDate + ? { + until: recurrenceEndDate, + } + : recurrenceEnds === 'afterx' + ? { + count: occurrences, + } + : {}; + if (frequency === 'CUSTOM') { + return { ...customFrequency, ...recurrenceEndProps }; + } + return { + freq: frequency, + ...rrulePresets[frequency], + ...recurrenceEndProps, + }; + }, [frequency, rrulePresets, recurrenceEnds, customFrequency, recurrenceEndDate, occurrences]); + + useEffect(() => { + onChange(compiledRecurrenceSchedule); + }, [compiledRecurrenceSchedule, onChange]); + + return ( + +
+ + + setFrequency(e.target.value === 'CUSTOM' ? 'CUSTOM' : Number(e.target.value)) + } + compressed + /> + + {frequency === 'CUSTOM' && ( + + )} + + + + {recurrenceEnds === 'ondate' && ( + + + + )} + {recurrenceEnds === 'afterx' && ( + + + setOccurrrences(Number(e.target.value))} + /> + + + )} +
+ +
+ {i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.repeatsSummary', { + defaultMessage: 'Repeats {summary}', + values: { summary: recurrenceSummary(compiledRecurrenceSchedule) }, + })} +
+ + ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/translations.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/translations.tsx new file mode 100644 index 0000000000000..5eb60be028692 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/translations.tsx @@ -0,0 +1,121 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { RRuleFrequency } from '../../../../../../types'; + +export const i18nNthWeekday = (dayOfWeek: string) => [ + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurLast', { + defaultMessage: 'Monthly on the last {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurFirst', { + defaultMessage: 'Monthly on the first {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurSecond', { + defaultMessage: 'Monthly on the second {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurThird', { + defaultMessage: 'Monthly on the third {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurFourth', { + defaultMessage: 'Monthly on the fourth {dayOfWeek}', + values: { dayOfWeek }, + }), +]; + +export const i18nNthWeekdayShort = (dayOfWeek: string) => [ + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurLastShort', { + defaultMessage: 'On the last {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurFirstShort', { + defaultMessage: 'On the 1st {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurSecondShort', { + defaultMessage: 'On the 2nd {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurThirdShort', { + defaultMessage: 'On the 3rd {dayOfWeek}', + values: { dayOfWeek }, + }), + i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurFourthShort', { + defaultMessage: 'On the 4th {dayOfWeek}', + values: { dayOfWeek }, + }), +]; + +export const i18nFreqSummary = (interval: number) => ({ + [RRuleFrequency.DAILY]: i18n.translate( + 'xpack.triggersActionsUI.ruleSnoozeScheduler.recurDaySummary', + { + defaultMessage: '{interval, plural, one {day} other {# days}}', + values: { interval }, + } + ), + [RRuleFrequency.WEEKLY]: i18n.translate( + 'xpack.triggersActionsUI.ruleSnoozeScheduler.recurWeekSummary', + { + defaultMessage: '{interval, plural, one {week} other {# weeks}}', + values: { interval }, + } + ), + [RRuleFrequency.MONTHLY]: i18n.translate( + 'xpack.triggersActionsUI.ruleSnoozeScheduler.recurMonthSummary', + { + defaultMessage: '{interval, plural, one {month} other {# months}}', + values: { interval }, + } + ), + [RRuleFrequency.YEARLY]: i18n.translate( + 'xpack.triggersActionsUI.ruleSnoozeScheduler.recurYearSummary', + { + defaultMessage: '{interval, plural, one {year} other {# years}}', + values: { interval }, + } + ), +}); + +export const i18nEndControlOptions = (interval: number) => [ + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurDay', { + defaultMessage: '{interval, plural, one {day} other {days}}', + values: { interval }, + }), + value: RRuleFrequency.DAILY, + 'data-test-subj': 'ruleSnoozeSchedulerRecurDay', + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurWeek', { + defaultMessage: '{interval, plural, one {week} other {weeks}}', + values: { interval }, + }), + value: RRuleFrequency.WEEKLY, + 'data-test-subj': 'ruleSnoozeSchedulerRecurWeek', + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurMonth', { + defaultMessage: '{interval, plural, one {month} other {months}}', + values: { interval }, + }), + value: RRuleFrequency.MONTHLY, + 'data-test-subj': 'ruleSnoozeSchedulerRecurMonth', + }, + { + text: i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.recurYear', { + defaultMessage: '{interval, plural, one {year} other {years}}', + values: { interval }, + }), + value: RRuleFrequency.YEARLY, + 'data-test-subj': 'ruleSnoozeSchedulerRecurYear', + }, +]; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.scss b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.scss new file mode 100644 index 0000000000000..d69249faa74ee --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.scss @@ -0,0 +1,13 @@ +.RuleSnoozeScheduler__pseudofocus { + &:not(:focus) { + background-image: linear-gradient( + to top, + #07C, + #07C 2px, + transparent 2px, + transparent 100% + ); + background-size: 100% 100%; + outline: none; + } +} diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.tsx new file mode 100644 index 0000000000000..8fcdf10da9567 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/scheduler.tsx @@ -0,0 +1,365 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState, useCallback, useMemo } from 'react'; +import moment, { Moment } from 'moment'; +import { i18n } from '@kbn/i18n'; +import { useUiSetting } from '@kbn/kibana-react-plugin/public'; +import uuid from 'uuid'; +import { + EuiDatePicker, + EuiDatePickerRange, + EuiPanel, + EuiComboBox, + EuiFormRow, + EuiHorizontalRule, + EuiFlexGroup, + EuiFlexItem, + EuiSwitch, + EuiSpacer, + EuiButton, + EuiPopoverTitle, + EuiIcon, + EuiLink, +} from '@elastic/eui'; +import { RecurrenceSchedule, SnoozeSchedule } from '../../../../../types'; +import { RecurrenceScheduler } from './recurrence_scheduler'; + +import './scheduler.scss'; + +interface PanelOpts { + onSaveSchedule: (sched: SnoozeSchedule) => void; + onCancelSchedules: (ids: string[]) => void; + initialSchedule: SnoozeSchedule | null; + isLoading: boolean; +} + +export interface ComponentOpts extends PanelOpts { + onClose: () => void; + hasTitle: boolean; +} + +const TIMEZONE_OPTIONS = moment.tz?.names().map((n) => ({ label: n })) ?? [{ label: 'UTC' }]; + +const useDefaultTimzezone = () => { + const kibanaTz: string = useUiSetting('dateFormat:tz'); + if (!kibanaTz || kibanaTz === 'Browser') return moment.tz?.guess() ?? 'UTC'; + return kibanaTz; +}; + +export const RuleSnoozeScheduler: React.FunctionComponent = ({ + onClose, + initialSchedule, + hasTitle = true, + ...rest +}: ComponentOpts) => { + const title = + hasTitle && + (initialSchedule + ? i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.editSchedule', { + defaultMessage: 'Edit schedule', + }) + : i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.addSchedule', { + defaultMessage: 'Add schedule', + })); + + return ( + <> + {title && ( + + + + + + + + {title} + + + + + )} + + + ); +}; + +const RuleSnoozeSchedulerPanel: React.FunctionComponent = ({ + onSaveSchedule, + initialSchedule, + isLoading, + onCancelSchedules, +}) => { + // These two states form a state machine for whether or not the user's clicks on the datepicker apply to the start/end date or start/end time + // - State A: After the user clicks a start date: + // - Next date click will change the end date and move to state B + // - Time clicks change the start time, and continue to change the start time until the user clicks an end date + // - State B: After the user clicks an end date: + // - Next date click will change the start date and move to state A + // - Time clicks change the end time, and continue to change the end time until the user clicks a start date + // - State C: If the user clicks on the Start Date textbox: + // - Next date click will change the start date and move to state B + // - Time clicks change the start time, and continue to change the start time + // - State D: If the user clicks on the End Date textbox: + // - Next date click will change the end date and move to state A + // - Time clicks change the end time, and continue to change the end time + // Component initializes in State C + const [selectingEndDate, setSelectingEndDate] = useState(false); + const [selectingEndTime, setSelectingEndTime] = useState(false); + const minDate = useMemo( + () => moment(initialSchedule?.rRule.dtstart ?? undefined), + [initialSchedule] + ); + + const defaultTz = useDefaultTimzezone(); + const initialState = useMemo(() => { + if (!initialSchedule) { + return { + startDT: moment().add('24', 'h'), + endDT: moment().add('48', 'h'), + isRecurring: false, + recurrenceSchedule: null, + selectedTimezone: [{ label: defaultTz }], + }; + } + + const isRecurring = initialSchedule?.rRule?.freq != null; + + const recurrenceSchedule = !isRecurring + ? null + : ({ + ...initialSchedule.rRule, + ...(initialSchedule.rRule.until ? { until: moment(initialSchedule.rRule.until) } : {}), + } as RecurrenceSchedule); + + return { + startDT: moment(initialSchedule.rRule.dtstart), + endDT: moment(initialSchedule.rRule.dtstart).add(initialSchedule.duration, 'ms'), + isRecurring, + recurrenceSchedule, + selectedTimezone: [{ label: initialSchedule.rRule.tzid }], + }; + }, [initialSchedule, defaultTz]); + + const [startDT, setStartDT] = useState(initialState.startDT); + const [endDT, setEndDT] = useState(initialState.endDT); + + const [isRecurring, setIsRecurring] = useState(initialState.isRecurring); + const [recurrenceSchedule, setRecurrenceSchedule] = useState( + initialState.recurrenceSchedule + ); + + const [selectedTimezone, setSelectedTimezone] = useState(initialState.selectedTimezone); + + const onFocusStart = useCallback(() => { + setSelectingEndDate(false); + setSelectingEndTime(false); + }, [setSelectingEndDate]); + + const onFocusEnd = useCallback(() => { + setSelectingEndDate(true); + setSelectingEndTime(true); + }, [setSelectingEndDate]); + + const selectStartDT = useCallback( + (date, clearEndDT) => { + setStartDT(moment.max(date, minDate)); + if (clearEndDT) { + setEndDT(null); + setSelectingEndDate(true); + setSelectingEndTime(false); + } + }, + [setStartDT, setSelectingEndDate, minDate] + ); + const selectEndDT = useCallback( + (date) => { + setEndDT(date); + setSelectingEndTime(true); + setSelectingEndDate(false); + }, + [setEndDT, setSelectingEndDate] + ); + + const onSelectFromInline = useCallback( + (date) => { + const dateAsMoment = moment(date); + const newDateAfterStart = + !startDT || dateAsMoment.isAfter(startDT) || dateAsMoment.isSame(startDT); + const isEndDateTimeChange = + dateAsMoment.isSame(endDT, 'day') && !dateAsMoment.isSame(endDT, 'minute'); + const isStartDateTimeChange = + dateAsMoment.isSame(startDT, 'day') && + !dateAsMoment.isSame(startDT, 'minute') && + (!isEndDateTimeChange || !selectingEndTime); + + const applyToEndDate = + !isStartDateTimeChange && (selectingEndDate || (isEndDateTimeChange && selectingEndTime)); + if (applyToEndDate && newDateAfterStart) { + selectEndDT(date); + } else selectStartDT(date, !isStartDateTimeChange); + }, + [selectingEndDate, selectingEndTime, startDT, endDT, selectEndDT, selectStartDT] + ); + + const onClickSaveSchedule = useCallback(() => { + if (!startDT || !endDT) return; + const recurrence = + isRecurring && recurrenceSchedule + ? recurrenceSchedule + : { + count: 1, + }; + onSaveSchedule({ + id: initialSchedule?.id ?? uuid.v4(), + rRule: { + dtstart: startDT.toISOString(), + tzid: selectedTimezone[0].label ?? defaultTz, + ...recurrence, + }, + duration: endDT.valueOf() - startDT.valueOf(), + }); + }, [ + onSaveSchedule, + endDT, + startDT, + selectedTimezone, + isRecurring, + recurrenceSchedule, + initialSchedule, + defaultTz, + ]); + + const onCancelSchedule = useCallback(() => { + if (!initialSchedule?.id) return; + onCancelSchedules([initialSchedule.id]); + }, [initialSchedule, onCancelSchedules]); + + return ( + + + + + } + endDateControl={ + + } + /> + + + + + + + + + + + + + + + + + setIsRecurring(!isRecurring)} + checked={isRecurring} + /> + {isRecurring && ( + <> + + + + )} + + + {i18n.translate('xpack.triggersActionsUI.ruleSnoozeScheduler.saveSchedule', { + defaultMessage: 'Save schedule', + })} + + {initialSchedule && ( + <> + + + + + {i18n.translate('xpack.triggersActionsUI.sections.rulesList.deleteSchedule', { + defaultMessage: 'Delete schedule', + })} + + + + + )} + + ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_dropdown.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_dropdown.tsx index 194bf86030e56..ff4d13d67d93f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_dropdown.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_dropdown.tsx @@ -8,73 +8,40 @@ import React, { useState, useEffect, useCallback } from 'react'; import moment from 'moment'; import { i18n } from '@kbn/i18n'; +import type { RuleSnooze } from '@kbn/alerting-plugin/common'; import { - useGeneratedHtmlId, EuiLoadingSpinner, EuiPopover, EuiContextMenu, EuiBadge, EuiPanel, - EuiFieldNumber, - EuiSelect, EuiFlexGroup, EuiFlexItem, - EuiButton, - EuiHorizontalRule, - EuiTitle, - EuiFlexGrid, - EuiSpacer, - EuiLink, EuiText, EuiToolTip, - EuiButtonEmpty, } from '@elastic/eui'; -import { parseInterval } from '../../../../../common'; +import type { SnoozeSchedule } from '../../../../types'; +import { SnoozePanel } from './rule_snooze'; import { Rule } from '../../../../types'; export type SnoozeUnit = 'm' | 'h' | 'd' | 'w' | 'M'; const SNOOZE_END_TIME_FORMAT = 'LL @ LT'; -type DropdownRuleRecord = Pick; +type DropdownRuleRecord = Pick; export interface ComponentOpts { rule: DropdownRuleRecord; onRuleChanged: () => void; enableRule: () => Promise; disableRule: () => Promise; - snoozeRule: (snoozeEndTime: string | -1, interval: string | null) => Promise; - unsnoozeRule: () => Promise; + snoozeRule: (snoozeSchedule: SnoozeSchedule) => Promise; + unsnoozeRule: (scheduleIds?: string[]) => Promise; isEditable: boolean; - previousSnoozeInterval?: string | null; direction?: 'column' | 'row'; hideSnoozeOption?: boolean; } -const COMMON_SNOOZE_TIMES: Array<[number, SnoozeUnit]> = [ - [1, 'h'], - [3, 'h'], - [8, 'h'], - [1, 'd'], -]; - -const PREV_SNOOZE_INTERVAL_KEY = 'triggersActionsUi_previousSnoozeInterval'; -export const usePreviousSnoozeInterval: ( - p?: string | null -) => [string | null, (n: string) => void] = (propsInterval) => { - const intervalFromStorage = localStorage.getItem(PREV_SNOOZE_INTERVAL_KEY); - const usePropsInterval = typeof propsInterval !== 'undefined'; - const interval = usePropsInterval ? propsInterval : intervalFromStorage; - const [previousSnoozeInterval, setPreviousSnoozeInterval] = useState(interval); - const storeAndSetPreviousSnoozeInterval = (newInterval: string) => { - if (!usePropsInterval) { - localStorage.setItem(PREV_SNOOZE_INTERVAL_KEY, newInterval); - } - setPreviousSnoozeInterval(newInterval); - }; - return [previousSnoozeInterval, storeAndSetPreviousSnoozeInterval]; -}; - export const isRuleSnoozed = (rule: { isSnoozedUntil?: Date | null; muteAll: boolean }) => Boolean( (rule.isSnoozedUntil && new Date(rule.isSnoozedUntil).getTime() > Date.now()) || rule.muteAll @@ -88,36 +55,23 @@ export const RuleStatusDropdown: React.FunctionComponent = ({ snoozeRule, unsnoozeRule, isEditable, - previousSnoozeInterval: propsPreviousSnoozeInterval, hideSnoozeOption = false, direction = 'column', }: ComponentOpts) => { const [isEnabled, setIsEnabled] = useState(rule.enabled); - const [isSnoozed, setIsSnoozed] = useState(isRuleSnoozed(rule)); - const [previousSnoozeInterval, setPreviousSnoozeInterval] = usePreviousSnoozeInterval( - propsPreviousSnoozeInterval - ); + const [isSnoozed, setIsSnoozed] = useState(!hideSnoozeOption && isRuleSnoozed(rule)); useEffect(() => { setIsEnabled(rule.enabled); }, [rule.enabled]); useEffect(() => { - setIsSnoozed(isRuleSnoozed(rule)); - }, [rule]); + if (!hideSnoozeOption) setIsSnoozed(isRuleSnoozed(rule)); + }, [rule, hideSnoozeOption]); const [isUpdating, setIsUpdating] = useState(false); const [isPopoverOpen, setIsPopoverOpen] = useState(false); const onClickBadge = useCallback(() => setIsPopoverOpen((isOpen) => !isOpen), [setIsPopoverOpen]); const onClosePopover = useCallback(() => setIsPopoverOpen(false), [setIsPopoverOpen]); - const snoozeRuleAndStoreInterval = useCallback( - (snoozeEndTime: string | -1, interval: string | null) => { - if (interval) { - setPreviousSnoozeInterval(interval); - } - return snoozeRule(snoozeEndTime, interval); - }, - [setPreviousSnoozeInterval, snoozeRule] - ); const onChangeEnabledStatus = useCallback( async (enable: boolean) => { @@ -139,23 +93,29 @@ export const RuleStatusDropdown: React.FunctionComponent = ({ }, [rule.enabled, isEnabled, onRuleChanged, enableRule, disableRule] ); - const onChangeSnooze = useCallback( - async (value: number, unit?: SnoozeUnit) => { - setIsUpdating(true); + + const onSnoozeRule = useCallback( + async (snoozeSchedule) => { try { - if (value === -1) { - await snoozeRuleAndStoreInterval(-1, null); - } else if (value !== 0) { - const snoozeEndTime = moment().add(value, unit).toISOString(); - await snoozeRuleAndStoreInterval(snoozeEndTime, `${value}${unit}`); - } else await unsnoozeRule(); - setIsSnoozed(value !== 0); + await snoozeRule(snoozeSchedule); onRuleChanged(); } finally { - setIsUpdating(false); + onClosePopover(); } }, - [setIsUpdating, setIsSnoozed, onRuleChanged, snoozeRuleAndStoreInterval, unsnoozeRule] + [snoozeRule, onRuleChanged, onClosePopover] + ); + + const onUnsnoozeRule = useCallback( + async (scheduleIds) => { + try { + await unsnoozeRule(scheduleIds); + onRuleChanged(); + } finally { + onClosePopover(); + } + }, + [unsnoozeRule, onRuleChanged, onClosePopover] ); const badgeColor = !isEnabled ? 'default' : isSnoozed ? 'warning' : 'primary'; @@ -221,12 +181,13 @@ export const RuleStatusDropdown: React.FunctionComponent = ({ ) : ( @@ -242,47 +203,41 @@ export const RuleStatusDropdown: React.FunctionComponent = ({ interface RuleStatusMenuProps { onChangeEnabledStatus: (enabled: boolean) => void; - onChangeSnooze: (value: number | -1, unit?: SnoozeUnit) => void; onClosePopover: () => void; isEnabled: boolean; isSnoozed: boolean; snoozeEndTime?: Date | null; - previousSnoozeInterval: string | null; hideSnoozeOption?: boolean; + snoozeRule: (snoozeSchedule: SnoozeSchedule) => Promise; + unsnoozeRule: (scheduleIds?: string[]) => Promise; + scheduledSnoozes?: RuleSnooze; } const RuleStatusMenu: React.FunctionComponent = ({ onChangeEnabledStatus, - onChangeSnooze, onClosePopover, isEnabled, isSnoozed, snoozeEndTime, - previousSnoozeInterval, hideSnoozeOption = false, + snoozeRule, + unsnoozeRule, + scheduledSnoozes = [], }) => { const enableRule = useCallback(() => { if (isSnoozed) { // Unsnooze if the rule is snoozed and the user clicks Enabled - onChangeSnooze(0, 'm'); + unsnoozeRule(); } else { onChangeEnabledStatus(true); } onClosePopover(); - }, [onChangeEnabledStatus, onClosePopover, onChangeSnooze, isSnoozed]); + }, [onChangeEnabledStatus, onClosePopover, unsnoozeRule, isSnoozed]); const disableRule = useCallback(() => { onChangeEnabledStatus(false); onClosePopover(); }, [onChangeEnabledStatus, onClosePopover]); - const onApplySnooze = useCallback( - (value: number, unit?: SnoozeUnit) => { - onChangeSnooze(value, unit); - onClosePopover(); - }, - [onClosePopover, onChangeSnooze] - ); - let snoozeButtonTitle = {SNOOZE}; if (isSnoozed && snoozeEndTime) { snoozeButtonTitle = ( @@ -315,15 +270,17 @@ const RuleStatusMenu: React.FunctionComponent = ({ return [ { id: 1, - width: 360, + width: 400, title: SNOOZE, content: ( - + ), @@ -359,166 +316,6 @@ const RuleStatusMenu: React.FunctionComponent = ({ return ; }; -interface SnoozePanelProps { - interval?: string; - isLoading?: boolean; - applySnooze: (value: number | -1, unit?: SnoozeUnit) => void; - showCancel: boolean; - previousSnoozeInterval: string | null; -} - -export const SnoozePanel: React.FunctionComponent = ({ - interval = '3d', - isLoading = false, - applySnooze, - showCancel, - previousSnoozeInterval, -}) => { - const [intervalValue, setIntervalValue] = useState(parseInterval(interval).value); - const [intervalUnit, setIntervalUnit] = useState(parseInterval(interval).unit); - - const onChangeValue = useCallback( - ({ target }) => setIntervalValue(target.value), - [setIntervalValue] - ); - const onChangeUnit = useCallback( - ({ target }) => setIntervalUnit(target.value), - [setIntervalUnit] - ); - - const onApplyIndefinite = useCallback(() => applySnooze(-1), [applySnooze]); - const onClickApplyButton = useCallback( - () => applySnooze(intervalValue, intervalUnit as SnoozeUnit), - [applySnooze, intervalValue, intervalUnit] - ); - const onCancelSnooze = useCallback(() => applySnooze(0, 'm'), [applySnooze]); - - const parsedPrevSnooze = previousSnoozeInterval ? parseInterval(previousSnoozeInterval) : null; - const prevSnoozeEqualsCurrentSnooze = - parsedPrevSnooze?.value === intervalValue && parsedPrevSnooze?.unit === intervalUnit; - const previousButton = parsedPrevSnooze && !prevSnoozeEqualsCurrentSnooze && ( - <> - - - applySnooze(parsedPrevSnooze.value, parsedPrevSnooze.unit as SnoozeUnit)} - > - {i18n.translate('xpack.triggersActionsUI.sections.rulesList.previousSnooze', { - defaultMessage: 'Previous', - })} - - - - - {durationToTextString(parsedPrevSnooze.value, parsedPrevSnooze.unit as SnoozeUnit)} - - - - - - ); - return ( - <> - - - - - - - - - - - {i18n.translate('xpack.triggersActionsUI.sections.rulesList.applySnooze', { - defaultMessage: 'Apply', - })} - - - - - {previousButton} - - - -
- {i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeCommonlyUsed', { - defaultMessage: 'Commonly used', - })} -
- - - - {COMMON_SNOOZE_TIMES.map(([value, unit]) => ( - - applySnooze(value, unit)}> - {durationToTextString(value, unit)} - - - ))} - - - - - - {i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeIndefinitely', { - defaultMessage: 'Snooze indefinitely', - })} - - - - {showCancel && ( - <> - - - - - Cancel snooze - - - - - )} - - - ); -}; - export const futureTimeToInterval = (time?: Date | null) => { if (!time) return; const relativeTime = moment(time).locale('en').fromNow(true); @@ -553,15 +350,6 @@ export const futureTimeToInterval = (time?: Date | null) => { return `${value}${unit}`; }; -const durationToTextString = (value: number, unit: SnoozeUnit) => { - // Moment.humanize will parse "1" as "a" or "an", e.g "an hour" - // Override this to output "1 hour" - if (value === 1) { - return ONE[unit]; - } - return moment.duration(value, unit).humanize(); -}; - const ENABLED = i18n.translate('xpack.triggersActionsUI.sections.rulesList.enabledRuleStatus', { defaultMessage: 'Enabled', }); @@ -585,45 +373,10 @@ const OPEN_MENU_ARIA_LABEL = i18n.translate( } ); -const MINUTES = i18n.translate('xpack.triggersActionsUI.sections.rulesList.minutesLabel', { - defaultMessage: 'minutes', -}); -const HOURS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.hoursLabel', { - defaultMessage: 'hours', -}); -const DAYS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.daysLabel', { - defaultMessage: 'days', -}); -const WEEKS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.weeksLabel', { - defaultMessage: 'weeks', -}); -const MONTHS = i18n.translate('xpack.triggersActionsUI.sections.rulesList.monthsLabel', { - defaultMessage: 'months', -}); - const INDEFINITELY = i18n.translate( 'xpack.triggersActionsUI.sections.rulesList.remainingSnoozeIndefinite', { defaultMessage: 'Indefinitely' } ); -// i18n constants to override moment.humanize -const ONE: Record = { - m: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneMinute', { - defaultMessage: '1 minute', - }), - h: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneHour', { - defaultMessage: '1 hour', - }), - d: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneDay', { - defaultMessage: '1 day', - }), - w: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneWeek', { - defaultMessage: '1 week', - }), - M: i18n.translate('xpack.triggersActionsUI.sections.rulesList.snoozeOneMonth', { - defaultMessage: '1 month', - }), -}; - // eslint-disable-next-line import/no-default-export export { RuleStatusDropdown as default }; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx index 571fd1f947b14..3d54ae8bee5d7 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx @@ -49,6 +49,7 @@ import { Pagination, Percentiles, TriggersActionsUiConfig, + SnoozeSchedule, } from '../../../../types'; import { RuleAdd, RuleEdit } from '../../rule_form'; import { BulkOperationPopover } from '../../common/components/bulk_operation_popover'; @@ -403,12 +404,12 @@ export const RulesList: React.FunctionComponent = () => { return enableRule({ http, id: rule.id }); }; - const onSnoozeRule = (rule: RuleTableItem, snoozeEndTime: string | -1) => { - return snoozeRule({ http, id: rule.id, snoozeEndTime }); + const onSnoozeRule = (rule: RuleTableItem, snoozeSchedule: SnoozeSchedule) => { + return snoozeRule({ http, id: rule.id, snoozeSchedule }); }; - const onUnsnoozeRule = (rule: RuleTableItem) => { - return unsnoozeRule({ http, id: rule.id }); + const onUnsnoozeRule = (rule: RuleTableItem, scheduleIds?: string[]) => { + return unsnoozeRule({ http, id: rule.id, scheduleIds }); }; const toolsRight = [ diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.test.tsx index e59a847eb11b2..229a24aa2100f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.test.tsx @@ -4,14 +4,15 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ + +import { EuiButtonIcon, EuiButton } from '@elastic/eui'; import React from 'react'; +import { act } from 'react-dom/test-utils'; import moment from 'moment'; -import { EuiButtonIcon, EuiButton } from '@elastic/eui'; + import { RuleTableItem } from '../../../../types'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { RulesListNotifyBadge } from './rules_list_notify_badge'; -import { RulesListSnoozePanel } from './rules_list_snooze_panel'; -import { act } from 'react-dom/test-utils'; jest.mock('../../../../common/lib/kibana'); @@ -127,15 +128,17 @@ describe('RulesListNotifyBadge', () => { ); // Snooze for 1 hour - wrapper - .find(RulesListSnoozePanel) - .find({ children: '1 hour' }) - .find('button') - .first() - .simulate('click'); + wrapper.find('button[data-test-subj="linkSnooze1h"]').first().simulate('click'); expect(onLoading).toHaveBeenCalledWith(true); - expect(onClose).toHaveBeenCalled(); - expect(snoozeRule).toHaveBeenCalledWith(expect.stringContaining('1990'), '1h'); + expect(snoozeRule).toHaveBeenCalledWith({ + duration: 3600000, + id: null, + rRule: { + count: 1, + dtstart: '1990-01-01T05:00:00.000Z', + tzid: 'America/New_York', + }, + }); await act(async () => { jest.runOnlyPendingTimers(); @@ -143,6 +146,7 @@ describe('RulesListNotifyBadge', () => { expect(onRuleChanged).toHaveBeenCalled(); expect(onLoading).toHaveBeenCalledWith(false); + expect(onClose).toHaveBeenCalled(); }); it('should allow the user to unsnooze rules', async () => { @@ -166,7 +170,6 @@ describe('RulesListNotifyBadge', () => { // Unsnooze wrapper.find('[data-test-subj="ruleSnoozeCancel"] button').simulate('click'); expect(onLoading).toHaveBeenCalledWith(true); - expect(onClose).toHaveBeenCalled(); await act(async () => { jest.runOnlyPendingTimers(); @@ -174,5 +177,6 @@ describe('RulesListNotifyBadge', () => { expect(unsnoozeRule).toHaveBeenCalled(); expect(onLoading).toHaveBeenCalledWith(false); + expect(onClose).toHaveBeenCalled(); }); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.tsx index f32913ce5eb83..d9ec9bc5c4f64 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_notify_badge.tsx @@ -5,23 +5,36 @@ * 2.0. */ -import React, { useMemo } from 'react'; +import React, { useCallback, useMemo } from 'react'; import moment from 'moment'; -import { - EuiButton, - EuiButtonIcon, - EuiPopover, - EuiText, - EuiToolTip, - EuiFlexGroup, - EuiFlexItem, - EuiIcon, - EuiPopoverTitle, -} from '@elastic/eui'; +import { EuiButton, EuiButtonIcon, EuiPopover, EuiText, EuiToolTip } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { isRuleSnoozed } from './rule_status_dropdown'; -import { RuleTableItem } from '../../../../types'; -import { RulesListSnoozePanel } from './rules_list_snooze_panel'; +import { RuleSnooze, RuleSnoozeSchedule } from '@kbn/alerting-plugin/common'; +import { i18nAbbrMonthDayDate, i18nMonthDayDate } from '../../../lib/i18n_month_day_date'; +import { RuleTableItem, SnoozeSchedule } from '../../../../types'; +import { SnoozePanel, futureTimeToInterval } from './rule_snooze'; +import { useKibana } from '../../../../common/lib/kibana'; + +export const SNOOZE_SUCCESS_MESSAGE = i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.snoozeSuccess', + { + defaultMessage: 'Rule successfully snoozed', + } +); + +export const UNSNOOZE_SUCCESS_MESSAGE = i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.unsnoozeSuccess', + { + defaultMessage: 'Rule successfully unsnoozed', + } +); + +export const SNOOZE_FAILED_MESSAGE = i18n.translate( + 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.snoozeFailed', + { + defaultMessage: 'Unabled to change rule snooze settings', + } +); export interface RulesListNotifyBadgeProps { rule: RuleTableItem; @@ -31,9 +44,9 @@ export interface RulesListNotifyBadgeProps { onClick: React.MouseEventHandler; onClose: () => void; onLoading: (isLoading: boolean) => void; - onRuleChanged: () => Promise; - snoozeRule: (snoozeEndTime: string | -1, interval: string | null) => Promise; - unsnoozeRule: () => Promise; + onRuleChanged: () => void; + snoozeRule: (schedule: SnoozeSchedule, muteAll?: boolean) => Promise; + unsnoozeRule: (scheduleIds?: string[]) => Promise; } const openSnoozePanelAriaLabel = i18n.translate( @@ -41,12 +54,27 @@ const openSnoozePanelAriaLabel = i18n.translate( { defaultMessage: 'Open snooze panel' } ); +export const isRuleSnoozed = (rule: { isSnoozedUntil?: Date | null; muteAll: boolean }) => + Boolean( + (rule.isSnoozedUntil && new Date(rule.isSnoozedUntil).getTime() > Date.now()) || rule.muteAll + ); + +const getNextRuleSnoozeSchedule = (rule: { snoozeSchedule?: RuleSnooze }) => { + if (!rule.snoozeSchedule || rule.snoozeSchedule.length === 0) return null; + const nextSchedule = rule.snoozeSchedule.reduce( + (a: RuleSnoozeSchedule, b: RuleSnoozeSchedule) => { + if (moment(b.rRule.dtstart).isBefore(moment(a.rRule.dtstart))) return b; + return a; + } + ); + return nextSchedule; +}; + export const RulesListNotifyBadge: React.FunctionComponent = (props) => { const { isLoading = false, rule, isOpen, - previousSnoozeInterval, onClick, onClose, onLoading, @@ -59,21 +87,28 @@ export const RulesListNotifyBadge: React.FunctionComponent { return isRuleSnoozed(rule); }, [rule]); + const nextScheduledSnooze = useMemo(() => getNextRuleSnoozeSchedule(rule), [rule]); + const isScheduled = useMemo(() => { - // TODO: Implement scheduled check - return false; - }, []); + return !isSnoozed && Boolean(nextScheduledSnooze); + }, [nextScheduledSnooze, isSnoozed]); const formattedSnoozeText = useMemo(() => { if (!isSnoozedUntil) { + if (nextScheduledSnooze) + return i18nAbbrMonthDayDate(moment(nextScheduledSnooze.rRule.dtstart)); return ''; } - return moment(isSnoozedUntil).format('MMM D'); - }, [isSnoozedUntil]); + return i18nAbbrMonthDayDate(moment(isSnoozedUntil)); + }, [isSnoozedUntil, nextScheduledSnooze]); const snoozeTooltipText = useMemo(() => { if (isSnoozedIndefinitely) { @@ -83,8 +118,15 @@ export const RulesListNotifyBadge: React.FunctionComponent { return ( @@ -197,34 +239,60 @@ export const RulesListNotifyBadge: React.FunctionComponent{button}; }, [isOpen, button, snoozeTooltipText]); + const onClosePopover = useCallback(() => { + onClose(); + // Set a timeout on closing the scheduler to avoid flicker + // setTimeout(onCloseScheduler, 1000); + }, [onClose]); + + const onApplySnooze = useCallback( + async (schedule: SnoozeSchedule) => { + try { + onLoading(true); + await snoozeRule(schedule); + onRuleChanged(); + toasts.addSuccess(SNOOZE_SUCCESS_MESSAGE); + } catch (e) { + toasts.addDanger(SNOOZE_FAILED_MESSAGE); + } finally { + onLoading(false); + onClosePopover(); + } + }, + [onLoading, snoozeRule, onRuleChanged, toasts, onClosePopover] + ); + + const onApplyUnsnooze = useCallback( + async (scheduleIds?: string[]) => { + try { + onLoading(true); + await unsnoozeRule(scheduleIds); + onRuleChanged(); + toasts.addSuccess(UNSNOOZE_SUCCESS_MESSAGE); + } catch (e) { + toasts.addDanger(SNOOZE_FAILED_MESSAGE); + } finally { + onLoading(false); + onClosePopover(); + } + }, + [onLoading, unsnoozeRule, onRuleChanged, toasts, onClosePopover] + ); + return ( - - - - - - - {i18n.translate( - 'xpack.triggersActionsUI.sections.rulesList.rulesListNotifyBadge.snoozeActions', - { defaultMessage: 'Snooze actions' } - )} - - - - ); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_snooze_panel.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_snooze_panel.tsx deleted file mode 100644 index d02376975b3f6..0000000000000 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_snooze_panel.tsx +++ /dev/null @@ -1,123 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { useCallback, useMemo } from 'react'; -import moment from 'moment'; -import { i18n } from '@kbn/i18n'; -import { RuleTableItem } from '../../../../types'; -import { useKibana } from '../../../../common/lib/kibana'; -import { - SnoozePanel, - futureTimeToInterval, - usePreviousSnoozeInterval, - SnoozeUnit, - isRuleSnoozed, -} from './rule_status_dropdown'; - -export const SNOOZE_SUCCESS_MESSAGE = i18n.translate( - 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.snoozeSuccess', - { - defaultMessage: 'Rule successfully snoozed', - } -); - -export const UNSNOOZE_SUCCESS_MESSAGE = i18n.translate( - 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.unsnoozeSuccess', - { - defaultMessage: 'Rule successfully unsnoozed', - } -); - -export const SNOOZE_FAILED_MESSAGE = i18n.translate( - 'xpack.triggersActionsUI.sections.rulesList.rulesListSnoozePanel.snoozeFailed', - { - defaultMessage: 'Unabled to change rule snooze settings', - } -); - -const EMPTY_HANDLER = () => {}; - -export interface RulesListSnoozePanelProps { - rule: RuleTableItem; - previousSnoozeInterval?: string | null; - onLoading?: (isLoading: boolean) => void; - onRuleChanged: () => Promise; - onClose: () => void; - snoozeRule: (snoozeEndTime: string | -1, interval: string | null) => Promise; - unsnoozeRule: () => Promise; -} - -export const RulesListSnoozePanel = (props: RulesListSnoozePanelProps) => { - const { - rule, - previousSnoozeInterval: propsPreviousSnoozeInterval, - onRuleChanged, - onClose, - snoozeRule, - unsnoozeRule, - onLoading = EMPTY_HANDLER, - } = props; - - const { - notifications: { toasts }, - } = useKibana().services; - - const { isSnoozedUntil } = rule; - - const [previousSnoozeInterval, setPreviousSnoozeInterval] = usePreviousSnoozeInterval( - propsPreviousSnoozeInterval - ); - - const isSnoozed = useMemo(() => { - return isRuleSnoozed(rule); - }, [rule]); - - const snoozeRuleAndStoreInterval = useCallback( - (newSnoozeEndTime: string | -1, interval: string | null) => { - if (interval) { - setPreviousSnoozeInterval(interval); - } - return snoozeRule(newSnoozeEndTime, interval); - }, - [setPreviousSnoozeInterval, snoozeRule] - ); - - const onChangeSnooze = useCallback( - async (value: number, unit?: SnoozeUnit) => { - onLoading(true); - onClose(); - try { - if (value === -1) { - await snoozeRuleAndStoreInterval(-1, null); - toasts.addSuccess(SNOOZE_SUCCESS_MESSAGE); - } else if (value !== 0) { - const newSnoozeEndTime = moment().add(value, unit).toISOString(); - await snoozeRuleAndStoreInterval(newSnoozeEndTime, `${value}${unit}`); - toasts.addSuccess(SNOOZE_SUCCESS_MESSAGE); - } else { - await unsnoozeRule(); - toasts.addSuccess(UNSNOOZE_SUCCESS_MESSAGE); - } - } catch (e) { - toasts.addDanger(SNOOZE_FAILED_MESSAGE); - } finally { - await onRuleChanged(); - onLoading(false); - } - }, - [toasts, onRuleChanged, snoozeRuleAndStoreInterval, unsnoozeRule, onLoading, onClose] - ); - - return ( - - ); -}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_table.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_table.tsx index a97a0c289c93f..692c10191c2ce 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_table.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_table.tsx @@ -46,6 +46,7 @@ import { Percentiles, TriggersActionsUiConfig, RuleTypeRegistryContract, + SnoozeSchedule, } from '../../../../types'; import { shouldShowDurationWarning } from '../../../lib/execution_duration_utils'; import { PercentileSelectablePopover } from './percentile_selectable_popover'; @@ -116,8 +117,8 @@ export interface RulesListTableProps { onRuleChanged: () => Promise; onEnableRule: (rule: RuleTableItem) => Promise; onDisableRule: (rule: RuleTableItem) => Promise; - onSnoozeRule: (rule: RuleTableItem, snoozeEndTime: string | -1) => Promise; - onUnsnoozeRule: (rule: RuleTableItem) => Promise; + onSnoozeRule: (rule: RuleTableItem, snoozeSchedule: SnoozeSchedule) => Promise; + onUnsnoozeRule: (rule: RuleTableItem, scheduleIds?: string[]) => Promise; renderCollapsedItemActions?: ( rule: RuleTableItem, onLoading: (isLoading: boolean) => void @@ -242,10 +243,8 @@ export const RulesListTable = (props: RulesListTableProps) => { hideSnoozeOption disableRule={async () => await onDisableRule(rule)} enableRule={async () => await onEnableRule(rule)} - snoozeRule={async (snoozeEndTime: string | -1, interval: string | null) => { - await onSnoozeRule(rule, snoozeEndTime); - }} - unsnoozeRule={async () => await onUnsnoozeRule(rule)} + snoozeRule={async () => {}} + unsnoozeRule={async () => {}} rule={rule} onRuleChanged={onRuleChanged} isEditable={rule.isEditable && isRuleTypeEditableInContext(rule.ruleTypeId)} @@ -449,10 +448,10 @@ export const RulesListTable = (props: RulesListTableProps) => { onClick={() => setCurrentlyOpenNotify(rule.id)} onClose={() => setCurrentlyOpenNotify('')} onRuleChanged={onRuleChanged} - snoozeRule={async (snoozeEndTime: string | -1, interval: string | null) => { - await onSnoozeRule(rule, snoozeEndTime); + snoozeRule={async (snoozeSchedule) => { + await onSnoozeRule(rule, snoozeSchedule); }} - unsnoozeRule={async () => await onUnsnoozeRule(rule)} + unsnoozeRule={async (scheduleIds) => await onUnsnoozeRule(rule, scheduleIds)} /> ); }, diff --git a/x-pack/plugins/triggers_actions_ui/public/types.ts b/x-pack/plugins/triggers_actions_ui/public/types.ts index 6923fe51d39d6..d88567adf5d40 100644 --- a/x-pack/plugins/triggers_actions_ui/public/types.ts +++ b/x-pack/plugins/triggers_actions_ui/public/types.ts @@ -5,6 +5,7 @@ * 2.0. */ +import type { Moment } from 'moment'; import type { ComponentType, ReactNode } from 'react'; import type { PublicMethodsOf } from '@kbn/utility-types'; import type { DocLinksStart } from '@kbn/core/public'; @@ -437,6 +438,32 @@ export enum AlertsTableFlyoutState { export type RuleStatus = 'enabled' | 'disabled' | 'snoozed'; +export enum RRuleFrequency { + YEARLY = 0, + MONTHLY = 1, + WEEKLY = 2, + DAILY = 3, +} + +export interface RecurrenceSchedule { + freq: RRuleFrequency; + interval: number; + until?: Moment; + count?: number; + byweekday?: string[]; + bymonthday?: number[]; + bymonth?: number[]; +} + +export interface SnoozeSchedule { + id: string | null; + duration: number; + rRule: Partial & { + dtstart: string; + tzid: string; + }; +} + export interface ConnectorServices { validateEmailAddresses: ActionsPublicPluginSetup['validateEmailAddresses']; } diff --git a/x-pack/plugins/ux/e2e/journeys/index.ts b/x-pack/plugins/ux/e2e/journeys/index.ts index 7440afe377ac3..36976caaa458d 100644 --- a/x-pack/plugins/ux/e2e/journeys/index.ts +++ b/x-pack/plugins/ux/e2e/journeys/index.ts @@ -8,3 +8,4 @@ export * from './core_web_vitals'; export * from './url_ux_query.journey'; export * from './ux_js_errors.journey'; +export * from './ux_client_metrics.journey'; diff --git a/x-pack/plugins/ux/e2e/journeys/ux_client_metrics.journey.ts b/x-pack/plugins/ux/e2e/journeys/ux_client_metrics.journey.ts new file mode 100644 index 0000000000000..7d0d426d5fd0d --- /dev/null +++ b/x-pack/plugins/ux/e2e/journeys/ux_client_metrics.journey.ts @@ -0,0 +1,78 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { journey, step, expect, before } from '@elastic/synthetics'; +import { UXDashboardDatePicker } from '../page_objects/date_picker'; +import { byTestId, loginToKibana, waitForLoadingToFinish } from './utils'; + +const totalPageLoadValue = '4.24 s'; +const totalPageLoadLabel = `Total + +${totalPageLoadValue}`; +const backendLabel = `Backend + +359 ms`; +const frontendLabel = `Frontend + +3.88 s`; +const pageViewsLabel = `Total page views + +524`; + +journey('UX ClientMetrics', async ({ page, params }) => { + before(async () => { + await waitForLoadingToFinish({ page }); + }); + + const queryParams = { + percentile: '50', + rangeFrom: '2020-05-18T11:51:00.000Z', + rangeTo: '2021-10-30T06:37:15.536Z', + }; + const queryString = new URLSearchParams(queryParams).toString(); + + const baseUrl = `${params.kibanaUrl}/app/ux`; + + step('Go to UX Dashboard', async () => { + await page.goto(`${baseUrl}?${queryString}`, { + waitUntil: 'networkidle', + }); + await loginToKibana({ + page, + user: { username: 'viewer_user', password: 'changeme' }, + }); + }); + + step('Set date range', async () => { + const datePickerPage = new UXDashboardDatePicker(page); + await datePickerPage.setDefaultE2eRange(); + }); + + step('Confirm metrics values', async () => { + // Wait until chart data is loaded + page.waitForLoadState('networkidle'); + await page.waitForSelector(`text=${totalPageLoadValue}`); + + const totalPageLoad = await ( + await page.waitForSelector(byTestId('uxClientMetrics-totalPageLoad')) + ).innerText(); + const backend = await ( + await page.waitForSelector(byTestId('uxClientMetrics-backend')) + ).innerText(); + const frontend = await ( + await page.waitForSelector(byTestId('uxClientMetrics-frontend')) + ).innerText(); + const pageViews = await ( + await page.waitForSelector(byTestId('uxClientMetrics-pageViews')) + ).innerText(); + + expect(totalPageLoad).toBe(totalPageLoadLabel); + expect(backend).toBe(backendLabel); + expect(frontend).toBe(frontendLabel); + expect(pageViews).toBe(pageViewsLabel); + }); +}); diff --git a/x-pack/plugins/ux/public/components/app/rum_dashboard/client_metrics/metrics.tsx b/x-pack/plugins/ux/public/components/app/rum_dashboard/client_metrics/metrics.tsx index f8196db691073..d08cf258194d0 100644 --- a/x-pack/plugins/ux/public/components/app/rum_dashboard/client_metrics/metrics.tsx +++ b/x-pack/plugins/ux/public/components/app/rum_dashboard/client_metrics/metrics.tsx @@ -16,9 +16,8 @@ import { EuiToolTip, EuiIconTip, } from '@elastic/eui'; -import { useFetcher } from '../../../../hooks/use_fetcher'; +import { useClientMetricsQuery } from '../../../../hooks/use_client_metrics_query'; import { I18LABELS } from '../translations'; -import { useUxQuery } from '../hooks/use_ux_query'; import { formatToSec } from '../ux_metrics/key_ux_metrics'; import { CsmSharedContext } from '../csm_shared_context'; @@ -49,23 +48,7 @@ function PageViewsTotalTitle({ pageViews }: { pageViews?: number }) { } export function Metrics() { - const uxQuery = useUxQuery(); - - const { data, status } = useFetcher( - (callApmApi) => { - if (uxQuery) { - return callApmApi('GET /internal/apm/ux/client-metrics', { - params: { - query: { - ...uxQuery, - }, - }, - }); - } - return Promise.resolve(null); - }, - [uxQuery] - ); + const { data, loading } = useClientMetricsQuery(); const { setSharedData } = useContext(CsmSharedContext); @@ -79,6 +62,7 @@ export function Metrics() { } - isLoading={status !== 'success'} + isLoading={!!loading} /> } - isLoading={status !== 'success'} + isLoading={!!loading} /> } - isLoading={status !== 'success'} + isLoading={!!loading} /> } description={I18LABELS.pageViews} - isLoading={status !== 'success'} + isLoading={!!loading} /> diff --git a/x-pack/plugins/ux/public/hooks/use_client_metrics_query.ts b/x-pack/plugins/ux/public/hooks/use_client_metrics_query.ts new file mode 100644 index 0000000000000..a28e59453b1ee --- /dev/null +++ b/x-pack/plugins/ux/public/hooks/use_client_metrics_query.ts @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEsSearch } from '@kbn/observability-plugin/public'; +import { useMemo } from 'react'; +import { useDataView } from '../components/app/rum_dashboard/local_uifilters/use_data_view'; +import { useLegacyUrlParams } from '../context/url_params_context/use_url_params'; +import { callDateMath } from '../services/data/call_date_math'; +import { clientMetricsQuery } from '../services/data/client_metrics_query'; + +export function useClientMetricsQuery() { + const { + rangeId, + urlParams: { start, end, percentile = 50, searchTerm }, + uxUiFilters, + } = useLegacyUrlParams(); + const { dataViewTitle } = useDataView(); + const { data: esQueryResponse, loading } = useEsSearch( + { + index: dataViewTitle, + ...clientMetricsQuery( + callDateMath(start), + callDateMath(end), + percentile, + searchTerm, + uxUiFilters + ), + }, + [start, end, percentile, searchTerm, uxUiFilters, dataViewTitle, rangeId], + { name: 'UxClientMetrics' } + ); + + const data = useMemo(() => { + if (!esQueryResponse) return {}; + + const { + hasFetchStartField: { backEnd, totalPageLoadDuration }, + } = esQueryResponse.aggregations!; + + const pkey = percentile.toFixed(1); + + const totalPageLoadDurationValue = totalPageLoadDuration.values[pkey] ?? 0; + const totalPageLoadDurationValueMs = totalPageLoadDurationValue / 1000; // Microseconds to milliseconds + const backendValue = backEnd.values[pkey] ?? 0; + + return { + pageViews: { value: (esQueryResponse.hits.total as any as number) ?? 0 }, + totalPageLoadDuration: { value: totalPageLoadDurationValueMs }, + backEnd: { value: backendValue }, + frontEnd: { value: totalPageLoadDurationValueMs - backendValue }, + }; + }, [esQueryResponse, percentile]); + + return { data, loading }; +} diff --git a/x-pack/plugins/ux/public/services/data/__snapshots__/client_metrics_query.test.ts.snap b/x-pack/plugins/ux/public/services/data/__snapshots__/client_metrics_query.test.ts.snap new file mode 100644 index 0000000000000..9957c50bf52c9 --- /dev/null +++ b/x-pack/plugins/ux/public/services/data/__snapshots__/client_metrics_query.test.ts.snap @@ -0,0 +1,76 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`clientMetricsQuery fetches client metrics 1`] = ` +Object { + "body": Object { + "aggs": Object { + "hasFetchStartField": Object { + "aggs": Object { + "backEnd": Object { + "percentiles": Object { + "field": "transaction.marks.agent.timeToFirstByte", + "hdr": Object { + "number_of_significant_value_digits": 3, + }, + "percents": Array [ + 50, + ], + }, + }, + "totalPageLoadDuration": Object { + "percentiles": Object { + "field": "transaction.duration.us", + "hdr": Object { + "number_of_significant_value_digits": 3, + }, + "percents": Array [ + 50, + ], + }, + }, + }, + "filter": Object { + "exists": Object { + "field": "transaction.marks.navigationTiming.fetchStart", + }, + }, + }, + }, + "query": Object { + "bool": Object { + "filter": Array [ + Object { + "range": Object { + "@timestamp": Object { + "format": "epoch_millis", + "gte": 0, + "lte": 50000, + }, + }, + }, + Object { + "term": Object { + "transaction.type": "page-load", + }, + }, + Object { + "terms": Object { + "processor.event": Array [ + "transaction", + ], + }, + }, + Object { + "term": Object { + "service.environment": "staging", + }, + }, + ], + "must_not": Array [], + }, + }, + "size": 0, + "track_total_hits": true, + }, +} +`; \ No newline at end of file diff --git a/x-pack/plugins/ux/public/services/data/__snapshots__/core_web_vitals_query.test.ts.snap b/x-pack/plugins/ux/public/services/data/__snapshots__/core_web_vitals_query.test.ts.snap index 8810a3e97aca8..510ee84a042e4 100644 --- a/x-pack/plugins/ux/public/services/data/__snapshots__/core_web_vitals_query.test.ts.snap +++ b/x-pack/plugins/ux/public/services/data/__snapshots__/core_web_vitals_query.test.ts.snap @@ -99,6 +99,13 @@ Object { "transaction.type": "page-load", }, }, + Object { + "terms": Object { + "processor.event": Array [ + "transaction", + ], + }, + }, Object { "exists": Object { "field": "transaction.marks.navigationTiming.fetchStart", diff --git a/x-pack/plugins/ux/public/services/data/__snapshots__/service_name_query.test.ts.snap b/x-pack/plugins/ux/public/services/data/__snapshots__/service_name_query.test.ts.snap index 45cebebe8f386..2a3fbbd8b120f 100644 --- a/x-pack/plugins/ux/public/services/data/__snapshots__/service_name_query.test.ts.snap +++ b/x-pack/plugins/ux/public/services/data/__snapshots__/service_name_query.test.ts.snap @@ -28,6 +28,13 @@ Object { "transaction.type": "page-load", }, }, + Object { + "terms": Object { + "processor.event": Array [ + "transaction", + ], + }, + }, Object { "exists": Object { "field": "transaction.marks.navigationTiming.fetchStart", diff --git a/x-pack/plugins/ux/public/services/data/client_metrics_query.test.ts b/x-pack/plugins/ux/public/services/data/client_metrics_query.test.ts new file mode 100644 index 0000000000000..7af6b0c7bcfd3 --- /dev/null +++ b/x-pack/plugins/ux/public/services/data/client_metrics_query.test.ts @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { clientMetricsQuery } from './client_metrics_query'; + +describe('clientMetricsQuery', () => { + it('fetches client metrics', () => { + const query = clientMetricsQuery(0, 50000, 50, '', { + environment: 'staging', + }); + expect(query).toMatchSnapshot(); + }); +}); diff --git a/x-pack/plugins/ux/public/services/data/client_metrics_query.ts b/x-pack/plugins/ux/public/services/data/client_metrics_query.ts new file mode 100644 index 0000000000000..1ab7eacb59855 --- /dev/null +++ b/x-pack/plugins/ux/public/services/data/client_metrics_query.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mergeProjection } from '../../../common/utils/merge_projection'; +import { SetupUX, UxUIFilters } from '../../../typings/ui_filters'; +import { + TRANSACTION_TIME_TO_FIRST_BYTE, + TRANSACTION_DURATION, +} from '../../../common/elasticsearch_fieldnames'; +import { getRumPageLoadTransactionsProjection } from './projections'; + +export function clientMetricsQuery( + start: number, + end: number, + percentile: number = 50, + urlQuery?: string, + uiFilters?: UxUIFilters +) { + const setup: SetupUX = { uiFilters: uiFilters ? uiFilters : {} }; + const projection = getRumPageLoadTransactionsProjection({ + setup, + urlQuery, + checkFetchStartFieldExists: false, + start, + end, + }); + + const params = mergeProjection(projection, { + body: { + size: 0, + track_total_hits: true, + aggs: { + hasFetchStartField: { + filter: { + exists: { field: 'transaction.marks.navigationTiming.fetchStart' }, + }, + aggs: { + totalPageLoadDuration: { + percentiles: { + field: TRANSACTION_DURATION, + percents: [percentile], + hdr: { + number_of_significant_value_digits: 3, + }, + }, + }, + backEnd: { + percentiles: { + field: TRANSACTION_TIME_TO_FIRST_BYTE, + percents: [percentile], + hdr: { + number_of_significant_value_digits: 3, + }, + }, + }, + }, + }, + }, + }, + }); + + return params; +} diff --git a/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts b/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts index 506727b315b3e..0f832eff6a2bd 100644 --- a/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts +++ b/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts @@ -158,6 +158,5 @@ export function coreWebVitalsQuery( }, }, }); - const { apm, ...rest } = params; - return rest; + return params; } diff --git a/x-pack/plugins/ux/public/services/data/projections.ts b/x-pack/plugins/ux/public/services/data/projections.ts index 35c5210a97e79..582639321b868 100644 --- a/x-pack/plugins/ux/public/services/data/projections.ts +++ b/x-pack/plugins/ux/public/services/data/projections.ts @@ -36,6 +36,7 @@ export function getRumPageLoadTransactionsProjection({ filter: [ ...rangeQuery(start, end), { term: { [TRANSACTION_TYPE]: TRANSACTION_PAGE_LOAD } }, + { terms: { [PROCESSOR_EVENT]: [ProcessorEvent.transaction] } }, ...(checkFetchStartFieldExists ? [ { @@ -62,9 +63,6 @@ export function getRumPageLoadTransactionsProjection({ }; return { - apm: { - events: [ProcessorEvent.transaction], - }, body: { query: { bool, diff --git a/x-pack/plugins/ux/public/services/data/service_name_query.ts b/x-pack/plugins/ux/public/services/data/service_name_query.ts index 1fa0809d0bd55..76eea53629e7e 100644 --- a/x-pack/plugins/ux/public/services/data/service_name_query.ts +++ b/x-pack/plugins/ux/public/services/data/service_name_query.ts @@ -37,6 +37,6 @@ export function serviceNameQuery( }, }, }); - const { apm, ...rest } = params; - return rest; + + return params; } diff --git a/x-pack/plugins/ux/public/services/data/url_search_query.ts b/x-pack/plugins/ux/public/services/data/url_search_query.ts index aa162e9174c01..e9f01ad6f827e 100644 --- a/x-pack/plugins/ux/public/services/data/url_search_query.ts +++ b/x-pack/plugins/ux/public/services/data/url_search_query.ts @@ -53,6 +53,5 @@ export function urlSearchQuery( }, }, }); - const { apm: _apm, ...rest } = params; - return rest; + return params; } diff --git a/x-pack/test/accessibility/apps/graph.ts b/x-pack/test/accessibility/apps/graph.ts new file mode 100644 index 0000000000000..d13ed5a58f871 --- /dev/null +++ b/x-pack/test/accessibility/apps/graph.ts @@ -0,0 +1,103 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const a11y = getService('a11y'); + const testSubjects = getService('testSubjects'); + const retry = getService('retry'); + const browser = getService('browser'); + const PageObjects = getPageObjects(['settings', 'common', 'graph', 'header', 'home']); + + describe('Graph app a11y tests', () => { + before(async () => { + await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { + useActualUrl: true, + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.home.addSampleDataSet('flights'); + await PageObjects.common.navigateToApp('graph'); + }); + + after(async () => { + await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { + useActualUrl: true, + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.home.removeSampleDataSet('flights'); + }); + + it('Graph listing page', async function () { + await a11y.testAppSnapshot(); + }); + + it('Edit Graph page', async function () { + await testSubjects.click('graphListingTitleLink-Kibana-Sample-Data---Flights'); + await a11y.testAppSnapshot(); + }); + + it('Syntax options panel', async function () { + await testSubjects.click('switchQueryLanguageButton'); + await a11y.testAppSnapshot(); + await browser.pressKeys(browser.keys.ESCAPE); + }); + + it('Add fields panel', async function () { + await testSubjects.click('graph-add-field-button'); + await retry.waitFor( + 'Add fields panel is visible', + async () => await testSubjects.exists('graph-add-field-button') + ); + await a11y.testAppSnapshot(); + await browser.pressKeys(browser.keys.ESCAPE); + }); + + it('Graph save panel', async function () { + await testSubjects.click('graphSaveButton'); + await a11y.testAppSnapshot(); + await testSubjects.click('saveCancelButton'); + }); + + it('Graph inspect panel', async function () { + await testSubjects.click('graphInspectButton'); + await a11y.testAppSnapshot(); + await testSubjects.click('graphInspectButton'); + }); + + it('Graph settings - advanced settings tab', async function () { + await testSubjects.click('graphSettingsButton'); + await a11y.testAppSnapshot(); + }); + + it('Graph settings - block list tab', async function () { + await testSubjects.click('blocklist'); + await a11y.testAppSnapshot(); + }); + + it('Graph settings - drilldowns tab', async function () { + await testSubjects.click('drillDowns'); + await a11y.testAppSnapshot(); + await browser.pressKeys(browser.keys.ESCAPE); + }); + + // https://github.com/elastic/kibana/issues/134693 + it.skip('Graph settings drilldown tab - add new drilldown', async function () { + await testSubjects.click('graphAddNewTemplate'); + await a11y.testAppSnapshot(); + await testSubjects.click('graphRemoveUrlTemplate'); + await testSubjects.click('euiFlyoutCloseButton'); + await browser.pressKeys(browser.keys.ESCAPE); + }); + + it('Create new graph page', async function () { + await testSubjects.click('graphNewButton'); + await testSubjects.click('confirmModalConfirmButton'); + await a11y.testAppSnapshot(); + }); + }); +} diff --git a/x-pack/test/accessibility/config.ts b/x-pack/test/accessibility/config.ts index 351865d296ec8..739ff5318bc10 100644 --- a/x-pack/test/accessibility/config.ts +++ b/x-pack/test/accessibility/config.ts @@ -36,6 +36,7 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { require.resolve('./apps/upgrade_assistant'), require.resolve('./apps/canvas'), require.resolve('./apps/maps'), + require.resolve('./apps/graph'), require.resolve('./apps/security_solution'), require.resolve('./apps/ml_embeddables_in_dashboard'), require.resolve('./apps/remote_clusters'), diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/snooze.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/snooze.ts index 0ca1ce4bf1eb7..2376e05635e9c 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/snooze.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/snooze.ts @@ -18,7 +18,15 @@ import { getProducerUnauthorizedErrorMessage, } from '../../../../common/lib'; -const FUTURE_SNOOZE_TIME = '9999-12-31T06:00:00.000Z'; +const NOW = new Date().toISOString(); +const SNOOZE_SCHEDULE = { + duration: 864000000, + rRule: { + dtstart: NOW, + tzid: 'UTC', + count: 1, + }, +}; // eslint-disable-next-line import/no-default-export export default function createSnoozeRuleTests({ getService }: FtrProviderContext) { @@ -67,7 +75,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext const response = await alertUtils .getSnoozeRequest(createdAlert.id) - .send({ snooze_end_time: FUTURE_SNOOZE_TIME }); + .send({ snooze_schedule: SNOOZE_SCHEDULE }); switch (scenario.id) { case 'no_kibana_privileges at space1': @@ -97,19 +105,15 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext case 'space_1_all_with_restricted_fixture at space1': expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); - const now = Date.now(); const { body: updatedAlert } = await supertestWithoutAuth .get(`${getUrlPrefix(space.id)}/internal/alerting/rule/${createdAlert.id}`) .set('kbn-xsrf', 'foo') .auth(user.username, user.password) .expect(200); expect(updatedAlert.snooze_schedule.length).to.eql(1); - // Due to latency, test to make sure the returned rRule.dtstart is within 10 seconds of the current time const { rRule, duration } = updatedAlert.snooze_schedule[0]; - expect(Math.abs(Date.parse(rRule.dtstart) - now) < 10000).to.be(true); - expect(Math.abs(duration - (Date.parse(FUTURE_SNOOZE_TIME) - now)) < 10000).to.be( - true - ); + expect(rRule.dtstart).to.eql(NOW); + expect(duration).to.eql(SNOOZE_SCHEDULE.duration); expect(updatedAlert.mute_all).to.eql(false); // Ensure AAD isn't broken await checkAAD({ @@ -140,7 +144,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext const response = await alertUtils .getSnoozeRequest(createdAlert.id) - .send({ snooze_end_time: FUTURE_SNOOZE_TIME }); + .send({ snooze_schedule: SNOOZE_SCHEDULE }); switch (scenario.id) { case 'no_kibana_privileges at space1': @@ -163,19 +167,15 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext case 'space_1_all_with_restricted_fixture at space1': expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); - const now = Date.now(); const { body: updatedAlert } = await supertestWithoutAuth .get(`${getUrlPrefix(space.id)}/internal/alerting/rule/${createdAlert.id}`) .set('kbn-xsrf', 'foo') .auth(user.username, user.password) .expect(200); expect(updatedAlert.snooze_schedule.length).to.eql(1); - // Due to latency, test to make sure the returned rRule.dtstart is within 10 seconds of the current time const { rRule, duration } = updatedAlert.snooze_schedule[0]; - expect(Math.abs(Date.parse(rRule.dtstart) - now) < 10000).to.be(true); - expect(Math.abs(duration - (Date.parse(FUTURE_SNOOZE_TIME) - now)) < 10000).to.be( - true - ); + expect(rRule.dtstart).to.eql(NOW); + expect(duration).to.eql(SNOOZE_SCHEDULE.duration); expect(updatedAlert.mute_all).to.eql(false); // Ensure AAD isn't broken await checkAAD({ @@ -206,7 +206,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext const response = await alertUtils .getSnoozeRequest(createdAlert.id) - .send({ snooze_end_time: FUTURE_SNOOZE_TIME }); + .send({ snooze_schedule: SNOOZE_SCHEDULE }); switch (scenario.id) { case 'no_kibana_privileges at space1': @@ -240,19 +240,15 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext case 'space_1_all_with_restricted_fixture at space1': expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); - const now = Date.now(); const { body: updatedAlert } = await supertestWithoutAuth .get(`${getUrlPrefix(space.id)}/internal/alerting/rule/${createdAlert.id}`) .set('kbn-xsrf', 'foo') .auth(user.username, user.password) .expect(200); expect(updatedAlert.snooze_schedule.length).to.eql(1); - // Due to latency, test to make sure the returned rRule.dtstart is within 10 seconds of the current time const { rRule, duration } = updatedAlert.snooze_schedule[0]; - expect(Math.abs(Date.parse(rRule.dtstart) - now) < 10000).to.be(true); - expect(Math.abs(duration - (Date.parse(FUTURE_SNOOZE_TIME) - now)) < 10000).to.be( - true - ); + expect(rRule.dtstart).to.eql(NOW); + expect(duration).to.eql(SNOOZE_SCHEDULE.duration); expect(updatedAlert.mute_all).to.eql(false); // Ensure AAD isn't broken await checkAAD({ @@ -283,7 +279,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext const response = await alertUtils .getSnoozeRequest(createdAlert.id) - .send({ snooze_end_time: FUTURE_SNOOZE_TIME }); + .send({ snooze_schedule: SNOOZE_SCHEDULE }); switch (scenario.id) { case 'no_kibana_privileges at space1': @@ -317,19 +313,15 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext case 'space_1_all_with_restricted_fixture at space1': expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); - const now = Date.now(); const { body: updatedAlert } = await supertestWithoutAuth .get(`${getUrlPrefix(space.id)}/internal/alerting/rule/${createdAlert.id}`) .set('kbn-xsrf', 'foo') .auth(user.username, user.password) .expect(200); expect(updatedAlert.snooze_schedule.length).to.eql(1); - // Due to latency, test to make sure the returned rRule.dtstart is within 10 seconds of the current time const { rRule, duration } = updatedAlert.snooze_schedule[0]; - expect(Math.abs(Date.parse(rRule.dtstart) - now) < 10000).to.be(true); - expect(Math.abs(duration - (Date.parse(FUTURE_SNOOZE_TIME) - now)) < 10000).to.be( - true - ); + expect(rRule.dtstart).to.eql(NOW); + expect(duration).to.eql(SNOOZE_SCHEDULE.duration); expect(updatedAlert.mute_all).to.eql(false); // Ensure AAD isn't broken await checkAAD({ @@ -344,7 +336,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext } }); - it('should handle snooze rule request appropriately when snoozeEndTime is -1', async () => { + it('should handle snooze rule request appropriately when duration is -1', async () => { const { body: createdAction } = await supertest .post(`${getUrlPrefix(space.id)}/api/actions/connector`) .set('kbn-xsrf', 'foo') @@ -374,9 +366,12 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext .expect(200); objectRemover.add(space.id, createdAlert.id, 'rule', 'alerting'); - const response = await alertUtils - .getSnoozeRequest(createdAlert.id) - .send({ snooze_end_time: -1 }); + const response = await alertUtils.getSnoozeRequest(createdAlert.id).send({ + snooze_schedule: { + ...SNOOZE_SCHEDULE, + duration: -1, + }, + }); switch (scenario.id) { case 'no_kibana_privileges at space1': diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/snooze.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/snooze.ts index 80cfa5a105467..02340f69718d6 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/snooze.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/snooze.ts @@ -17,7 +17,15 @@ import { getEventLog, } from '../../../common/lib'; -const FUTURE_SNOOZE_TIME = '9999-12-31T06:00:00.000Z'; +const NOW = new Date().toISOString(); +const SNOOZE_SCHEDULE = { + duration: 864000000, + rRule: { + dtstart: NOW, + tzid: 'UTC', + count: 1, + }, +}; // eslint-disable-next-line import/no-default-export export default function createSnoozeRuleTests({ getService }: FtrProviderContext) { @@ -66,20 +74,18 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext const response = await alertUtils .getSnoozeRequest(createdRule.id) - .send({ snooze_end_time: FUTURE_SNOOZE_TIME }); + .send({ snooze_schedule: SNOOZE_SCHEDULE }); expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); - const now = Date.now(); const { body: updatedAlert } = await supertestWithoutAuth .get(`${getUrlPrefix(Spaces.space1.id)}/internal/alerting/rule/${createdRule.id}`) .set('kbn-xsrf', 'foo') .expect(200); expect(updatedAlert.snooze_schedule.length).to.eql(1); - // Due to latency, test to make sure the returned rRule.dtstart is within 10 seconds of the current time const { rRule, duration } = updatedAlert.snooze_schedule[0]; - expect(Math.abs(Date.parse(rRule.dtstart) - now) < 10000).to.be(true); - expect(Math.abs(duration - (Date.parse(FUTURE_SNOOZE_TIME) - now)) < 10000).to.be(true); + expect(rRule.dtstart).to.eql(NOW); + expect(duration).to.eql(SNOOZE_SCHEDULE.duration); expect(updatedAlert.mute_all).to.eql(false); // Ensure AAD isn't broken await checkAAD({ @@ -90,7 +96,7 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext }); }); - it('should handle snooze rule request appropriately when snoozeEndTime is -1', async () => { + it('should handle snooze rule request appropriately when duration is -1', async () => { const { body: createdAction } = await supertest .post(`${getUrlPrefix(Spaces.space1.id)}/api/actions/connector`) .set('kbn-xsrf', 'foo') @@ -121,9 +127,12 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext .expect(200); objectRemover.add(Spaces.space1.id, createdRule.id, 'rule', 'alerting'); - const response = await alertUtils - .getSnoozeRequest(createdRule.id) - .send({ snooze_end_time: -1 }); + const response = await alertUtils.getSnoozeRequest(createdRule.id).send({ + snooze_schedule: { + ...SNOOZE_SCHEDULE, + duration: -1, + }, + }); expect(response.statusCode).to.eql(204); expect(response.body).to.eql(''); @@ -186,11 +195,19 @@ export default function createSnoozeRuleTests({ getService }: FtrProviderContext await getRuleEvents(createdRule.id); log.info('start snoozing'); + const now = new Date().toISOString(); const snoozeSeconds = 10; - const snoozeEndDate = new Date(Date.now() + 1000 * snoozeSeconds); - await alertUtils - .getSnoozeRequest(createdRule.id) - .send({ snooze_end_time: snoozeEndDate.toISOString() }); + const snoozeDuration = snoozeSeconds * 1000; + await alertUtils.getSnoozeRequest(createdRule.id).send({ + snooze_schedule: { + duration: snoozeDuration, + rRule: { + dtstart: now, + tzid: 'UTC', + count: 1, + }, + }, + }); // could be an action execution while calling snooze, so set snooze start // to a value that we know it will be in effect (after this call) diff --git a/x-pack/test/api_integration/apis/maps/get_tile.js b/x-pack/test/api_integration/apis/maps/get_tile.js index 6803b5e404ab0..344256d30413a 100644 --- a/x-pack/test/api_integration/apis/maps/get_tile.js +++ b/x-pack/test/api_integration/apis/maps/get_tile.js @@ -29,7 +29,7 @@ export default function ({ getService }) { ?geometryFieldName=geo.coordinates\ &hasLabels=false\ &index=logstash-*\ -&requestBody=(_source:!f,docvalue_fields:!(bytes,geo.coordinates,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10000,stored_fields:!(bytes,geo.coordinates,machine.os.raw,'@timestamp'))` +&requestBody=(_source:!f,fields:!(bytes,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),size:10000)` ) .set('kbn-xsrf', 'kibana') .responseType('blob') @@ -93,7 +93,7 @@ export default function ({ getService }) { ?geometryFieldName=geo.coordinates\ &hasLabels=true\ &index=logstash-*\ -&requestBody=(_source:!f,docvalue_fields:!(bytes,geo.coordinates,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10000,stored_fields:!(bytes,geo.coordinates,machine.os.raw,'@timestamp'))` +&requestBody=(_source:!f,fields:!(bytes,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),size:10000)` ) .set('kbn-xsrf', 'kibana') .responseType('blob') @@ -138,7 +138,7 @@ export default function ({ getService }) { ?geometryFieldName=geo.coordinates\ &hasLabels=false\ &index=notRealIndex\ -&requestBody=(_source:!f,docvalue_fields:!(bytes,geo.coordinates,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10000,stored_fields:!(bytes,geo.coordinates,machine.os.raw,'@timestamp'))` +&requestBody=(_source:!f,fields:!(bytes,machine.os.raw,(field:'@timestamp',format:epoch_millis)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),size:10000)` ) .set('kbn-xsrf', 'kibana') .responseType('blob') diff --git a/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/data.json.gz b/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/data.json.gz new file mode 100644 index 0000000000000..9d7f08e190b6e Binary files /dev/null and b/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/data.json.gz differ diff --git a/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/mappings.json b/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/mappings.json new file mode 100644 index 0000000000000..af532355fae7a --- /dev/null +++ b/x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8/mappings.json @@ -0,0 +1,779 @@ +{ + "type": "data_stream", + "value": { + "data_stream": ".monitoring-logstash-8-mb", + "template": { + "data_stream": { + "allow_custom_routing": false, + "hidden": false + }, + "index_patterns": [ + ".monitoring-logstash-8-*" + ], + "name": ".monitoring-logstash-mb", + "template": { + "mappings": { + "dynamic": false, + "properties": { + "@timestamp": { + "type": "date" + }, + "cluster_uuid": { + "path": "logstash.elasticsearch.cluster.id", + "type": "alias" + }, + "ecs": { + "properties": { + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "event": { + "properties": { + "action": { + "ignore_above": 1024, + "type": "keyword" + }, + "agent_id_status": { + "ignore_above": 1024, + "type": "keyword" + }, + "category": { + "ignore_above": 1024, + "type": "keyword" + }, + "code": { + "ignore_above": 1024, + "type": "keyword" + }, + "created": { + "type": "date" + }, + "dataset": { + "ignore_above": 1024, + "type": "keyword" + }, + "duration": { + "type": "long" + }, + "end": { + "type": "date" + }, + "hash": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "ingested": { + "type": "date" + }, + "kind": { + "ignore_above": 1024, + "type": "keyword" + }, + "module": { + "ignore_above": 1024, + "type": "keyword" + }, + "original": { + "doc_values": false, + "ignore_above": 1024, + "index": false, + "type": "keyword" + }, + "outcome": { + "ignore_above": 1024, + "type": "keyword" + }, + "provider": { + "ignore_above": 1024, + "type": "keyword" + }, + "reason": { + "ignore_above": 1024, + "type": "keyword" + }, + "reference": { + "ignore_above": 1024, + "type": "keyword" + }, + "risk_score": { + "type": "float" + }, + "risk_score_norm": { + "type": "float" + }, + "sequence": { + "type": "long" + }, + "severity": { + "type": "long" + }, + "start": { + "type": "date" + }, + "timezone": { + "ignore_above": 1024, + "type": "keyword" + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + }, + "url": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "host": { + "properties": { + "architecture": { + "ignore_above": 1024, + "type": "keyword" + }, + "hostname": { + "ignore_above": 1024, + "type": "keyword" + }, + "name": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "logstash": { + "properties": { + "elasticsearch": { + "properties": { + "cluster": { + "properties": { + "id": { + "ignore_above": 1024, + "type": "keyword" + } + } + } + } + }, + "node": { + "properties": { + "host": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "jvm": { + "properties": { + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "state": { + "properties": { + "pipeline": { + "properties": { + "batch_size": { + "type": "long" + }, + "ephemeral_id": { + "ignore_above": 1024, + "type": "keyword" + }, + "hash": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "representation": { + "properties": { + "graph": { + "properties": { + "edges": { + "type": "object" + }, + "vertices": { + "type": "object" + } + } + }, + "hash": { + "ignore_above": 1024, + "type": "keyword" + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "workers": { + "type": "long" + } + } + } + } + }, + "stats": { + "properties": { + "events": { + "properties": { + "duration_in_millis": { + "type": "long" + }, + "filtered": { + "type": "long" + }, + "in": { + "type": "long" + }, + "out": { + "type": "long" + } + } + }, + "jvm": { + "properties": { + "mem": { + "properties": { + "heap_max_in_bytes": { + "type": "long" + }, + "heap_used_in_bytes": { + "type": "long" + } + } + }, + "uptime_in_millis": { + "type": "long" + } + } + }, + "logstash": { + "properties": { + "uuid": { + "ignore_above": 1024, + "type": "keyword" + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "os": { + "properties": { + "cgroup": { + "properties": { + "cpu": { + "properties": { + "stat": { + "properties": { + "number_of_elapsed_periods": { + "type": "long" + }, + "number_of_times_throttled": { + "type": "long" + }, + "time_throttled_nanos": { + "type": "long" + } + } + } + } + }, + "cpuacct": { + "properties": { + "usage_nanos": { + "type": "long" + } + } + } + } + }, + "cpu": { + "properties": { + "load_average": { + "properties": { + "15m": { + "type": "long" + }, + "1m": { + "type": "long" + }, + "5m": { + "type": "long" + } + } + } + } + } + } + }, + "pipelines": { + "properties": { + "ephemeral_id": { + "type": "keyword" + }, + "events": { + "properties": { + "duration_in_millis": { + "type": "long" + }, + "filtered": { + "type": "long" + }, + "in": { + "type": "long" + }, + "out": { + "type": "long" + }, + "queue_push_duration_in_millis": { + "type": "long" + } + } + }, + "hash": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "queue": { + "properties": { + "events_count": { + "type": "long" + }, + "max_queue_size_in_bytes": { + "type": "long" + }, + "queue_size_in_bytes": { + "type": "long" + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "reloads": { + "properties": { + "failures": { + "type": "long" + }, + "successes": { + "type": "long" + } + } + }, + "vertices": { + "properties": { + "duration_in_millis": { + "type": "long" + }, + "events_in": { + "type": "long" + }, + "events_out": { + "type": "long" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "long_counters": { + "properties": { + "name": { + "type": "keyword" + }, + "value": { + "type": "long" + } + }, + "type": "nested" + }, + "pipeline_ephemeral_id": { + "ignore_above": 1024, + "type": "keyword" + }, + "queue_push_duration_in_millis": { + "type": "long" + } + }, + "type": "nested" + } + }, + "type": "nested" + }, + "process": { + "properties": { + "cpu": { + "properties": { + "percent": { + "type": "double" + } + } + } + } + }, + "queue": { + "properties": { + "events_count": { + "type": "long" + } + } + } + } + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + } + } + }, + "logstash_state": { + "properties": { + "pipeline": { + "properties": { + "hash": { + "path": "logstash.node.state.pipeline.hash", + "type": "alias" + }, + "id": { + "path": "logstash.node.state.pipeline.id", + "type": "alias" + } + } + } + } + }, + "logstash_stats": { + "properties": { + "events": { + "properties": { + "duration_in_millis": { + "path": "logstash.node.stats.events.duration_in_millis", + "type": "alias" + }, + "in": { + "path": "logstash.node.stats.events.in", + "type": "alias" + }, + "out": { + "path": "logstash.node.stats.events.out", + "type": "alias" + } + } + }, + "jvm": { + "properties": { + "mem": { + "properties": { + "heap_max_in_bytes": { + "path": "logstash.node.stats.jvm.mem.heap_max_in_bytes", + "type": "alias" + }, + "heap_used_in_bytes": { + "path": "logstash.node.stats.jvm.mem.heap_used_in_bytes", + "type": "alias" + } + } + }, + "uptime_in_millis": { + "path": "logstash.node.stats.jvm.uptime_in_millis", + "type": "alias" + } + } + }, + "logstash": { + "properties": { + "uuid": { + "path": "logstash.node.stats.logstash.uuid", + "type": "alias" + }, + "version": { + "path": "logstash.node.stats.logstash.version", + "type": "alias" + } + } + }, + "os": { + "properties": { + "cgroup": { + "properties": { + "cpuacct": { + "properties": { + "usage_nanos": { + "path": "logstash.node.stats.os.cgroup.cpuacct.usage_nanos", + "type": "alias" + } + } + } + } + }, + "cpu": { + "properties": { + "load_average": { + "properties": { + "15m": { + "path": "logstash.node.stats.os.cpu.load_average.15m", + "type": "alias" + }, + "1m": { + "path": "logstash.node.stats.os.cpu.load_average.1m", + "type": "alias" + }, + "5m": { + "path": "logstash.node.stats.os.cpu.load_average.5m", + "type": "alias" + } + } + }, + "stat": { + "properties": { + "number_of_elapsed_periods": { + "path": "logstash.node.stats.os.cgroup.cpu.stat.number_of_elapsed_periods", + "type": "alias" + }, + "number_of_times_throttled": { + "path": "logstash.node.stats.os.cgroup.cpu.stat.number_of_times_throttled", + "type": "alias" + }, + "time_throttled_nanos": { + "path": "logstash.node.stats.os.cgroup.cpu.stat.time_throttled_nanos", + "type": "alias" + } + } + } + } + } + } + }, + "pipelines": { + "type": "nested" + }, + "process": { + "properties": { + "cpu": { + "properties": { + "percent": { + "path": "logstash.node.stats.process.cpu.percent", + "type": "alias" + } + } + } + } + }, + "queue": { + "properties": { + "events_count": { + "path": "logstash.node.stats.queue.events_count", + "type": "alias" + } + } + }, + "timestamp": { + "path": "@timestamp", + "type": "alias" + } + } + }, + "metricset": { + "properties": { + "name": { + "ignore_above": 1024, + "type": "keyword" + }, + "period": { + "type": "long" + } + } + }, + "process": { + "properties": { + "pid": { + "type": "long" + } + } + }, + "service": { + "properties": { + "address": { + "ignore_above": 1024, + "type": "keyword" + }, + "environment": { + "ignore_above": 1024, + "type": "keyword" + }, + "ephemeral_id": { + "ignore_above": 1024, + "type": "keyword" + }, + "hostname": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "name": { + "ignore_above": 1024, + "type": "keyword" + }, + "node": { + "properties": { + "name": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "origin": { + "properties": { + "address": { + "ignore_above": 1024, + "type": "keyword" + }, + "environment": { + "ignore_above": 1024, + "type": "keyword" + }, + "ephemeral_id": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "name": { + "ignore_above": 1024, + "type": "keyword" + }, + "node": { + "properties": { + "name": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "state": { + "ignore_above": 1024, + "type": "keyword" + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "state": { + "ignore_above": 1024, + "type": "keyword" + }, + "target": { + "properties": { + "address": { + "ignore_above": 1024, + "type": "keyword" + }, + "environment": { + "ignore_above": 1024, + "type": "keyword" + }, + "ephemeral_id": { + "ignore_above": 1024, + "type": "keyword" + }, + "id": { + "ignore_above": 1024, + "type": "keyword" + }, + "name": { + "ignore_above": 1024, + "type": "keyword" + }, + "node": { + "properties": { + "name": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "state": { + "ignore_above": 1024, + "type": "keyword" + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "type": { + "ignore_above": 1024, + "type": "keyword" + }, + "version": { + "ignore_above": 1024, + "type": "keyword" + } + } + }, + "timestamp": { + "path": "@timestamp", + "type": "alias" + } + } + }, + "settings": { + "index": { + "lifecycle": { + "name": ".monitoring-8-ilm-policy" + }, + "mapping": { + "total_fields": { + "limit": "2000" + } + } + } + } + }, + "version": 8000101 + } + } +} \ No newline at end of file diff --git a/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_8.json b/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_8.json new file mode 100644 index 0000000000000..e283406909808 --- /dev/null +++ b/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_8.json @@ -0,0 +1,1523 @@ +{ + "metrics": { + "logstash_os_load": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cpu.load_average.1m", + "metricAgg": "max", + "label": "1m", + "title": "System Load", + "description": "Load average over the last minute.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 3 + ], + [ + 1655471950000, + 3 + ], + [ + 1655471960000, + 3 + ], + [ + 1655471970000, + 3 + ], + [ + 1655471980000, + 2 + ], + [ + 1655471990000, + 2 + ], + [ + 1655472000000, + 2 + ], + [ + 1655472010000, + 2 + ], + [ + 1655472020000, + 2 + ], + [ + 1655472030000, + 2 + ], + [ + 1655472040000, + 2 + ], + [ + 1655472050000, + 2 + ], + [ + 1655472060000, + 2 + ], + [ + 1655472070000, + 2 + ], + [ + 1655472080000, + 2 + ], + [ + 1655472090000, + 2 + ], + [ + 1655472100000, + 2 + ], + [ + 1655472110000, + 2 + ], + [ + 1655472120000, + 1 + ], + [ + 1655472130000, + 1 + ], + [ + 1655472140000, + 1 + ], + [ + 1655472150000, + 1 + ], + [ + 1655472160000, + 1 + ], + [ + 1655472170000, + 2 + ], + [ + 1655472180000, + 2 + ], + [ + 1655472190000, + 2 + ], + [ + 1655472200000, + 2 + ], + [ + 1655472210000, + 2 + ], + [ + 1655472220000, + 2 + ], + [ + 1655472230000, + 2 + ], + [ + 1655472240000, + 3 + ], + [ + 1655472250000, + 3 + ], + [ + 1655472260000, + 2 + ], + [ + 1655472270000, + 2 + ], + [ + 1655472280000, + 2 + ], + [ + 1655472290000, + 2 + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cpu.load_average.5m", + "metricAgg": "max", + "label": "5m", + "title": "System Load", + "description": "Load average over the last 5 minutes.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cpu.load_average.15m", + "metricAgg": "max", + "label": "15m", + "title": "System Load", + "description": "Load average over the last 15 minutes.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + } + ], + "logstash_events_input_rate": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.events.in", + "metricAgg": "max", + "label": "Events Received Rate", + "description": "Number of events received per second by the Logstash node at the inputs stage.", + "units": "/s", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + 10 + ], + [ + 1655471950000, + 10 + ], + [ + 1655471960000, + 10 + ], + [ + 1655471970000, + 10 + ], + [ + 1655471980000, + 10 + ], + [ + 1655471990000, + 10 + ], + [ + 1655472000000, + 10 + ], + [ + 1655472010000, + 10 + ], + [ + 1655472020000, + 10 + ], + [ + 1655472030000, + 10 + ], + [ + 1655472040000, + 10 + ], + [ + 1655472050000, + 10 + ], + [ + 1655472060000, + 10 + ], + [ + 1655472070000, + 10 + ], + [ + 1655472080000, + 10 + ], + [ + 1655472090000, + 10 + ], + [ + 1655472100000, + 10 + ], + [ + 1655472110000, + 10 + ], + [ + 1655472120000, + 10 + ], + [ + 1655472130000, + 10 + ], + [ + 1655472140000, + 10 + ], + [ + 1655472150000, + 10 + ], + [ + 1655472160000, + 10 + ], + [ + 1655472170000, + 10 + ], + [ + 1655472180000, + 10 + ], + [ + 1655472190000, + 10 + ], + [ + 1655472200000, + 10 + ], + [ + 1655472210000, + 10 + ], + [ + 1655472220000, + 10 + ], + [ + 1655472230000, + 10 + ], + [ + 1655472240000, + 10 + ], + [ + 1655472250000, + 10 + ], + [ + 1655472260000, + 10 + ], + [ + 1655472270000, + 10 + ], + [ + 1655472280000, + 10 + ], + [ + 1655472290000, + 10 + ] + ] + } + ], + "logstash_events_output_rate": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.events.out", + "metricAgg": "max", + "label": "Events Emitted Rate", + "description": "Number of events emitted per second by the Logstash node at the outputs stage.", + "units": "/s", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + 7 + ], + [ + 1655471950000, + 4.3 + ], + [ + 1655471960000, + 7.3 + ], + [ + 1655471970000, + 8.2 + ], + [ + 1655471980000, + 6 + ], + [ + 1655471990000, + 3.7 + ], + [ + 1655472000000, + 10.3 + ], + [ + 1655472010000, + 10.5 + ], + [ + 1655472020000, + 6.2 + ], + [ + 1655472030000, + 4.4 + ], + [ + 1655472040000, + 2.1 + ], + [ + 1655472050000, + 10.8 + ], + [ + 1655472060000, + 12.9 + ], + [ + 1655472070000, + 4.4 + ], + [ + 1655472080000, + 0 + ], + [ + 1655472090000, + 5.9 + ], + [ + 1655472100000, + 10.4 + ], + [ + 1655472110000, + 10.8 + ], + [ + 1655472120000, + 0.7 + ], + [ + 1655472130000, + 5.6 + ], + [ + 1655472140000, + 8.3 + ], + [ + 1655472150000, + 9.3 + ], + [ + 1655472160000, + 10.7 + ], + [ + 1655472170000, + 1.3 + ], + [ + 1655472180000, + 4.3 + ], + [ + 1655472190000, + 13.7 + ], + [ + 1655472200000, + 13.1 + ], + [ + 1655472210000, + 4.2 + ], + [ + 1655472220000, + 0 + ], + [ + 1655472230000, + 3.7 + ], + [ + 1655472240000, + 10.2 + ], + [ + 1655472250000, + 0 + ], + [ + 1655472260000, + 8.2 + ], + [ + 1655472270000, + 5.9 + ], + [ + 1655472280000, + 8.8 + ], + [ + 1655472290000, + 2.5 + ] + ] + } + ], + "logstash_events_latency": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.events.out", + "metricAgg": "sum", + "label": "Event Latency", + "description": "Average time spent by events in the filter and output stages, which is the total time it takes to process events divided by number of events emitted.", + "units": "ms", + "format": "0,0.[00]", + "hasCalculation": true, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + 2003.279069767442 + ], + [ + 1655471960000, + 2003.150684931507 + ], + [ + 1655471970000, + 1978.9146341463418 + ], + [ + 1655471980000, + 1969.45 + ], + [ + 1655471990000, + 2003.4864864864862 + ], + [ + 1655472000000, + 2002.9708737864075 + ], + [ + 1655472010000, + 1984.1809523809525 + ], + [ + 1655472020000, + 1970.5483870967741 + ], + [ + 1655472030000, + 2002.7954545454543 + ], + [ + 1655472040000, + 2002.6666666666667 + ], + [ + 1655472050000, + 2002.9629629629628 + ], + [ + 1655472060000, + 2002.7519379844962 + ], + [ + 1655472070000, + 2002.931818181818 + ], + [ + 1655472080000, + 0 + ], + [ + 1655472090000, + 2002.6440677966102 + ], + [ + 1655472100000, + 1983.9326923076924 + ], + [ + 1655472110000, + 2002.8425925925926 + ], + [ + 1655472120000, + 2003.4285714285718 + ], + [ + 1655472130000, + 2002.964285714286 + ], + [ + 1655472140000, + 2002.9518072289154 + ], + [ + 1655472150000, + 2002.9462365591398 + ], + [ + 1655472160000, + 2003.0093457943926 + ], + [ + 1655472170000, + 2002.5384615384617 + ], + [ + 1655472180000, + 2002.7906976744187 + ], + [ + 1655472190000, + 1973.7956204379564 + ], + [ + 1655472200000, + 1957.0381679389313 + ], + [ + 1655472210000, + 2002.6666666666667 + ], + [ + 1655472220000, + 0 + ], + [ + 1655472230000, + 2003.2432432432431 + ], + [ + 1655472240000, + 2003.029411764706 + ], + [ + 1655472250000, + 0 + ], + [ + 1655472260000, + 2003.0243902439024 + ], + [ + 1655472270000, + 2003.0338983050847 + ], + [ + 1655472280000, + 2002.9772727272727 + ], + [ + 1655472290000, + 2002.6799999999998 + ] + ] + } + ], + "logstash_node_cpu_metric": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.process.cpu.percent", + "metricAgg": "max", + "label": "CPU Utilization", + "description": "Percentage of CPU usage reported by the OS (100% is the max).", + "units": "%", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 0 + ], + [ + 1655471950000, + 0 + ], + [ + 1655471960000, + 0 + ], + [ + 1655471970000, + 0 + ], + [ + 1655471980000, + 0 + ], + [ + 1655471990000, + 0 + ], + [ + 1655472000000, + 0 + ], + [ + 1655472010000, + 0 + ], + [ + 1655472020000, + 0 + ], + [ + 1655472030000, + 0 + ], + [ + 1655472040000, + 0 + ], + [ + 1655472050000, + 0 + ], + [ + 1655472060000, + 0 + ], + [ + 1655472070000, + 0 + ], + [ + 1655472080000, + 0 + ], + [ + 1655472090000, + 0 + ], + [ + 1655472100000, + 0 + ], + [ + 1655472110000, + 0 + ], + [ + 1655472120000, + 0 + ], + [ + 1655472130000, + 0 + ], + [ + 1655472140000, + 0 + ], + [ + 1655472150000, + 0 + ], + [ + 1655472160000, + 0 + ], + [ + 1655472170000, + 0 + ], + [ + 1655472180000, + 0 + ], + [ + 1655472190000, + 0 + ], + [ + 1655472200000, + 0 + ], + [ + 1655472210000, + 0 + ], + [ + 1655472220000, + 0 + ], + [ + 1655472230000, + 0 + ], + [ + 1655472240000, + 0 + ], + [ + 1655472250000, + 0 + ], + [ + 1655472260000, + 0 + ], + [ + 1655472270000, + 0 + ], + [ + 1655472280000, + 0 + ], + [ + 1655472290000, + 0 + ] + ] + } + ], + "logstash_jvm_usage": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.jvm.mem.heap_max_in_bytes", + "metricAgg": "max", + "label": "Max Heap", + "title": "JVM Heap", + "description": "Total heap available to Logstash running in the JVM.", + "units": "B", + "format": "0.0 b", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 1037959168 + ], + [ + 1655471950000, + 1037959168 + ], + [ + 1655471960000, + 1037959168 + ], + [ + 1655471970000, + 1037959168 + ], + [ + 1655471980000, + 1037959168 + ], + [ + 1655471990000, + 1037959168 + ], + [ + 1655472000000, + 1037959168 + ], + [ + 1655472010000, + 1037959168 + ], + [ + 1655472020000, + 1037959168 + ], + [ + 1655472030000, + 1037959168 + ], + [ + 1655472040000, + 1037959168 + ], + [ + 1655472050000, + 1037959168 + ], + [ + 1655472060000, + 1037959168 + ], + [ + 1655472070000, + 1037959168 + ], + [ + 1655472080000, + 1037959168 + ], + [ + 1655472090000, + 1037959168 + ], + [ + 1655472100000, + 1037959168 + ], + [ + 1655472110000, + 1037959168 + ], + [ + 1655472120000, + 1037959168 + ], + [ + 1655472130000, + 1037959168 + ], + [ + 1655472140000, + 1037959168 + ], + [ + 1655472150000, + 1037959168 + ], + [ + 1655472160000, + 1037959168 + ], + [ + 1655472170000, + 1037959168 + ], + [ + 1655472180000, + 1037959168 + ], + [ + 1655472190000, + 1037959168 + ], + [ + 1655472200000, + 1037959168 + ], + [ + 1655472210000, + 1037959168 + ], + [ + 1655472220000, + 1037959168 + ], + [ + 1655472230000, + 1037959168 + ], + [ + 1655472240000, + 1037959168 + ], + [ + 1655472250000, + 1037959168 + ], + [ + 1655472260000, + 1037959168 + ], + [ + 1655472270000, + 1037959168 + ], + [ + 1655472280000, + 1037959168 + ], + [ + 1655472290000, + 1037959168 + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.jvm.mem.heap_used_in_bytes", + "metricAgg": "max", + "label": "Used Heap", + "title": "JVM Heap", + "description": "Total heap used by Logstash running in the JVM.", + "units": "B", + "format": "0.0 b", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 248983808 + ], + [ + 1655471950000, + 254463104 + ], + [ + 1655471960000, + 260278488 + ], + [ + 1655471970000, + 265273976 + ], + [ + 1655471980000, + 269846232 + ], + [ + 1655471990000, + 274251248 + ], + [ + 1655472000000, + 278416256 + ], + [ + 1655472010000, + 282938928 + ], + [ + 1655472020000, + 287769440 + ], + [ + 1655472030000, + 292220848 + ], + [ + 1655472040000, + 295623816 + ], + [ + 1655472050000, + 299332480 + ], + [ + 1655472060000, + 305022864 + ], + [ + 1655472070000, + 310001816 + ], + [ + 1655472080000, + 312599256 + ], + [ + 1655472090000, + 317015008 + ], + [ + 1655472100000, + 320427488 + ], + [ + 1655472110000, + 325544640 + ], + [ + 1655472120000, + 329544016 + ], + [ + 1655472130000, + 332205376 + ], + [ + 1655472140000, + 337552416 + ], + [ + 1655472150000, + 341823888 + ], + [ + 1655472160000, + 345948696 + ], + [ + 1655472170000, + 348979208 + ], + [ + 1655472180000, + 353352704 + ], + [ + 1655472190000, + 358819752 + ], + [ + 1655472200000, + 363752360 + ], + [ + 1655472210000, + 367726528 + ], + [ + 1655472220000, + 371043320 + ], + [ + 1655472230000, + 374659232 + ], + [ + 1655472240000, + 379147672 + ], + [ + 1655472250000, + 383031600 + ], + [ + 1655472260000, + 392741408 + ], + [ + 1655472270000, + 395632912 + ], + [ + 1655472280000, + 400452624 + ], + [ + 1655472290000, + 405401144 + ] + ] + } + ] + }, + "nodeSummary": { + "ephemeral_id": "88c01586-1891-4a0e-a2ca-ca5c988f8cbb", + "host": "kevins-macbook-pro.home", + "http_address": "127.0.0.1:9600", + "name": "kevins-macbook-pro.home", + "pipeline": { + "batch_size": 125, + "workers": 16 + }, + "snapshot": false, + "status": "green", + "uuid": "f9efd237-3bbf-4a9b-9ce7-a16141b9d981", + "version": "8.2.2", + "availability": false, + "events": { + "duration_in_millis": 5145881, + "filtered": 2579, + "in": 3978, + "out": 2579 + }, + "reloads": { + "failures": 0, + "successes": 0 + }, + "uptime": 407358 + } +} diff --git a/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_advanced_8.json b/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_advanced_8.json new file mode 100644 index 0000000000000..41760111cf055 --- /dev/null +++ b/x-pack/test/api_integration/apis/monitoring/logstash/fixtures/node_detail_advanced_8.json @@ -0,0 +1,1521 @@ +{ + "metrics": { + "logstash_node_cpu_utilization": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.process.cpu.percent", + "metricAgg": "max", + "label": "CPU Utilization", + "description": "Percentage of CPU usage reported by the OS (100% is the max).", + "units": "%", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 0 + ], + [ + 1655471950000, + 0 + ], + [ + 1655471960000, + 0 + ], + [ + 1655471970000, + 0 + ], + [ + 1655471980000, + 0 + ], + [ + 1655471990000, + 0 + ], + [ + 1655472000000, + 0 + ], + [ + 1655472010000, + 0 + ], + [ + 1655472020000, + 0 + ], + [ + 1655472030000, + 0 + ], + [ + 1655472040000, + 0 + ], + [ + 1655472050000, + 0 + ], + [ + 1655472060000, + 0 + ], + [ + 1655472070000, + 0 + ], + [ + 1655472080000, + 0 + ], + [ + 1655472090000, + 0 + ], + [ + 1655472100000, + 0 + ], + [ + 1655472110000, + 0 + ], + [ + 1655472120000, + 0 + ], + [ + 1655472130000, + 0 + ], + [ + 1655472140000, + 0 + ], + [ + 1655472150000, + 0 + ], + [ + 1655472160000, + 0 + ], + [ + 1655472170000, + 0 + ], + [ + 1655472180000, + 0 + ], + [ + 1655472190000, + 0 + ], + [ + 1655472200000, + 0 + ], + [ + 1655472210000, + 0 + ], + [ + 1655472220000, + 0 + ], + [ + 1655472230000, + 0 + ], + [ + 1655472240000, + 0 + ], + [ + 1655472250000, + 0 + ], + [ + 1655472260000, + 0 + ], + [ + 1655472270000, + 0 + ], + [ + 1655472280000, + 0 + ], + [ + 1655472290000, + 0 + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.process.cpu.percent", + "metricAgg": "max", + "label": "Cgroup CPU Utilization", + "title": "CPU Utilization", + "description": "CPU Usage time compared to the CPU quota shown in percentage. If CPU quotas are not set, then no data will be shown.", + "units": "%", + "format": "0,0.[00]", + "hasCalculation": true, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + } + ], + "logstash_node_cgroup_cpu": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cgroup.cpuacct.usage_nanos", + "metricAgg": "max", + "label": "Cgroup Usage", + "title": "Cgroup CPU Performance", + "description": "The usage, reported in nanoseconds, of the Cgroup. Compare this with the throttling to discover issues.", + "units": "ns", + "format": "0,0.[0]a", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cgroup.cpu.stat.time_throttled_nanos", + "metricAgg": "max", + "label": "Cgroup Throttling", + "title": "Cgroup CPU Performance", + "description": "The amount of throttled time, reported in nanoseconds, of the Cgroup.", + "units": "ns", + "format": "0,0.[0]a", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + } + ], + "logstash_node_cgroup_stats": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cgroup.cpu.stat.number_of_elapsed_periods", + "metricAgg": "max", + "label": "Cgroup Elapsed Periods", + "title": "Cgroup CFS Stats", + "description": "The number of sampling periods from the Completely Fair Scheduler (CFS). Compare against the number of times throttled.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.os.cgroup.cpu.stat.number_of_times_throttled", + "metricAgg": "max", + "label": "Cgroup Throttled Count", + "title": "Cgroup CFS Stats", + "description": "The number of times that the CPU was throttled by the Cgroup.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": true + }, + "data": [ + [ + 1655471940000, + null + ], + [ + 1655471950000, + null + ], + [ + 1655471960000, + null + ], + [ + 1655471970000, + null + ], + [ + 1655471980000, + null + ], + [ + 1655471990000, + null + ], + [ + 1655472000000, + null + ], + [ + 1655472010000, + null + ], + [ + 1655472020000, + null + ], + [ + 1655472030000, + null + ], + [ + 1655472040000, + null + ], + [ + 1655472050000, + null + ], + [ + 1655472060000, + null + ], + [ + 1655472070000, + null + ], + [ + 1655472080000, + null + ], + [ + 1655472090000, + null + ], + [ + 1655472100000, + null + ], + [ + 1655472110000, + null + ], + [ + 1655472120000, + null + ], + [ + 1655472130000, + null + ], + [ + 1655472140000, + null + ], + [ + 1655472150000, + null + ], + [ + 1655472160000, + null + ], + [ + 1655472170000, + null + ], + [ + 1655472180000, + null + ], + [ + 1655472190000, + null + ], + [ + 1655472200000, + null + ], + [ + 1655472210000, + null + ], + [ + 1655472220000, + null + ], + [ + 1655472230000, + null + ], + [ + 1655472240000, + null + ], + [ + 1655472250000, + null + ], + [ + 1655472260000, + null + ], + [ + 1655472270000, + null + ], + [ + 1655472280000, + null + ], + [ + 1655472290000, + null + ] + ] + } + ], + "logstash_queue_events_count": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.queue.events_count", + "metricAgg": "max", + "label": "Events Queued", + "title": "Persistent Queue Events", + "description": "Average number of events in the persistent queue waiting to be processed by the filter and output stages.", + "units": "", + "format": "0,0.[00]", + "hasCalculation": false, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 7 + ], + [ + 1655471950000, + 2 + ], + [ + 1655471960000, + 0 + ], + [ + 1655471970000, + 15 + ], + [ + 1655471980000, + 7 + ], + [ + 1655471990000, + 2 + ], + [ + 1655472000000, + 2 + ], + [ + 1655472010000, + 14 + ], + [ + 1655472020000, + 28 + ], + [ + 1655472030000, + 21 + ], + [ + 1655472040000, + 61 + ], + [ + 1655472050000, + 14 + ], + [ + 1655472060000, + 6 + ], + [ + 1655472070000, + 0 + ], + [ + 1655472080000, + 101 + ], + [ + 1655472090000, + 76 + ], + [ + 1655472100000, + 6 + ], + [ + 1655472110000, + 23 + ], + [ + 1655472120000, + 23 + ], + [ + 1655472130000, + 123 + ], + [ + 1655472140000, + 51 + ], + [ + 1655472150000, + 23 + ], + [ + 1655472160000, + 2 + ], + [ + 1655472170000, + 102 + ], + [ + 1655472180000, + 78 + ], + [ + 1655472190000, + 22 + ], + [ + 1655472200000, + 17 + ], + [ + 1655472210000, + 14 + ], + [ + 1655472220000, + 70 + ], + [ + 1655472230000, + 45 + ], + [ + 1655472240000, + 17 + ], + [ + 1655472250000, + 75 + ], + [ + 1655472260000, + 52 + ], + [ + 1655472270000, + 153 + ], + [ + 1655472280000, + 1 + ], + [ + 1655472290000, + 16 + ] + ] + } + ], + "logstash_pipeline_queue_size": [ + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.pipelines.queue.queue_size_in_bytes", + "label": "Queue Size", + "title": "Persistent Queue Size", + "description": "Current size of all persistent queues in the Logstash pipelines on this node.", + "units": "B", + "format": "0,0.0 b", + "hasCalculation": true, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 141265 + ], + [ + 1655471950000, + 173965 + ], + [ + 1655471960000, + 206665 + ], + [ + 1655471970000, + 239692 + ], + [ + 1655471980000, + 272392 + ], + [ + 1655471990000, + 305092 + ], + [ + 1655472000000, + 337792 + ], + [ + 1655472010000, + 370489 + ], + [ + 1655472020000, + 403189 + ], + [ + 1655472030000, + 435886 + ], + [ + 1655472040000, + 468586 + ], + [ + 1655472050000, + 501286 + ], + [ + 1655472060000, + 533986 + ], + [ + 1655472070000, + 566686 + ], + [ + 1655472080000, + 599713 + ], + [ + 1655472090000, + 632413 + ], + [ + 1655472100000, + 665110 + ], + [ + 1655472110000, + 697810 + ], + [ + 1655472120000, + 730510 + ], + [ + 1655472130000, + 763210 + ], + [ + 1655472140000, + 795910 + ], + [ + 1655472150000, + 828610 + ], + [ + 1655472160000, + 861307 + ], + [ + 1655472170000, + 894007 + ], + [ + 1655472180000, + 927034 + ], + [ + 1655472190000, + 959731 + ], + [ + 1655472200000, + 992431 + ], + [ + 1655472210000, + 1025131 + ], + [ + 1655472220000, + 1057831 + ], + [ + 1655472230000, + 1090531 + ], + [ + 1655472240000, + 1123231 + ], + [ + 1655472250000, + 1155931 + ], + [ + 1655472260000, + 1188631 + ], + [ + 1655472270000, + 1221331 + ], + [ + 1655472280000, + 1254358 + ], + [ + 1655472290000, + 1287058 + ] + ] + }, + { + "bucket_size": "10 seconds", + "timeRange": { + "min": 1655471940000, + "max": 1655472300000 + }, + "metric": { + "app": "logstash", + "field": "logstash_stats.pipelines.queue.max_queue_size_in_bytes", + "label": "Max Queue Size", + "description": "Maximum size set for the persistent queues on this node.", + "units": "B", + "format": "0,0.0 b", + "hasCalculation": true, + "isDerivative": false + }, + "data": [ + [ + 1655471940000, + 1073741824 + ], + [ + 1655471950000, + 1073741824 + ], + [ + 1655471960000, + 1073741824 + ], + [ + 1655471970000, + 1073741824 + ], + [ + 1655471980000, + 1073741824 + ], + [ + 1655471990000, + 1073741824 + ], + [ + 1655472000000, + 1073741824 + ], + [ + 1655472010000, + 1073741824 + ], + [ + 1655472020000, + 1073741824 + ], + [ + 1655472030000, + 1073741824 + ], + [ + 1655472040000, + 1073741824 + ], + [ + 1655472050000, + 1073741824 + ], + [ + 1655472060000, + 1073741824 + ], + [ + 1655472070000, + 1073741824 + ], + [ + 1655472080000, + 1073741824 + ], + [ + 1655472090000, + 1073741824 + ], + [ + 1655472100000, + 1073741824 + ], + [ + 1655472110000, + 1073741824 + ], + [ + 1655472120000, + 1073741824 + ], + [ + 1655472130000, + 1073741824 + ], + [ + 1655472140000, + 1073741824 + ], + [ + 1655472150000, + 1073741824 + ], + [ + 1655472160000, + 1073741824 + ], + [ + 1655472170000, + 1073741824 + ], + [ + 1655472180000, + 1073741824 + ], + [ + 1655472190000, + 1073741824 + ], + [ + 1655472200000, + 1073741824 + ], + [ + 1655472210000, + 1073741824 + ], + [ + 1655472220000, + 1073741824 + ], + [ + 1655472230000, + 1073741824 + ], + [ + 1655472240000, + 1073741824 + ], + [ + 1655472250000, + 1073741824 + ], + [ + 1655472260000, + 1073741824 + ], + [ + 1655472270000, + 1073741824 + ], + [ + 1655472280000, + 1073741824 + ], + [ + 1655472290000, + 1073741824 + ] + ] + } + ] + }, + "nodeSummary": { + "uuid": "f9efd237-3bbf-4a9b-9ce7-a16141b9d981", + "ephemeral_id": "88c01586-1891-4a0e-a2ca-ca5c988f8cbb", + "version": "8.2.2", + "snapshot": false, + "http_address": "127.0.0.1:9600", + "name": "kevins-macbook-pro.home", + "host": "kevins-macbook-pro.home", + "status": "green", + "pipeline": { + "workers": 16, + "batch_size": 125 + }, + "availability": false, + "events": { + "duration_in_millis": 5145881, + "in": 3978, + "filtered": 2579, + "out": 2579 + }, + "reloads": { + "failures": 0, + "successes": 0 + }, + "uptime": 407358 + } +} diff --git a/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js b/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js index ad4fdcb462fd9..5d58316a83d95 100644 --- a/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js +++ b/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js @@ -6,53 +6,49 @@ */ import expect from '@kbn/expect'; -import { normalizeDataTypeDifferences } from '../normalize_data_type_differences'; -import nodeDetailFixture from './fixtures/node_detail.json'; -import nodeDetailAdvancedFixture from './fixtures/node_detail_advanced.json'; -import { getLifecycleMethods } from '../data_stream'; +import nodeDetailFixture from './fixtures/node_detail_8.json'; +import nodeDetailAdvancedFixture from './fixtures/node_detail_advanced_8.json'; export default function ({ getService }) { const supertest = getService('supertest'); - const { setup, tearDown } = getLifecycleMethods(getService); + const esArchiver = getService('esArchiver'); describe('node detail mb', () => { - const archive = 'x-pack/test/functional/es_archives/monitoring/logstash_pipelines_mb'; + const archive = 'x-pack/test/api_integration/apis/monitoring/es_archives/logstash_8'; const timeRange = { - min: '2018-01-22T09:33:13.000Z', - max: '2018-01-22T09:41:04.000Z', + min: '2022-06-17T13:19:00.000Z', + max: '2022-06-17T13:25:00.000Z', }; before('load archive', () => { - return setup(archive); + return esArchiver.load(archive); }); after('unload archive', () => { - return tearDown(); + return esArchiver.unload(archive); }); it('should summarize the Logstash node with non-advanced chart data metrics', async () => { const { body } = await supertest .post( - '/api/monitoring/v1/clusters/1rhApLfQShSh3JsNqYCkmA/logstash/node/838a2ada-1951-4043-8a23-4b450f6160a4' + '/api/monitoring/v1/clusters/__standalone_cluster__/logstash/node/f9efd237-3bbf-4a9b-9ce7-a16141b9d981' ) .set('kbn-xsrf', 'xxx') .send({ timeRange, is_advanced: false }) .expect(200); - body.metrics = normalizeDataTypeDifferences(body.metrics, nodeDetailFixture); expect(body).to.eql(nodeDetailFixture); }); it('should summarize the Logstash node with advanced chart data metrics', async () => { const { body } = await supertest .post( - '/api/monitoring/v1/clusters/1rhApLfQShSh3JsNqYCkmA/logstash/node/838a2ada-1951-4043-8a23-4b450f6160a4' + '/api/monitoring/v1/clusters/__standalone_cluster__/logstash/node/f9efd237-3bbf-4a9b-9ce7-a16141b9d981' ) .set('kbn-xsrf', 'xxx') .send({ timeRange, is_advanced: true }) .expect(200); - body.metrics = normalizeDataTypeDifferences(body.metrics, nodeDetailAdvancedFixture); expect(body).to.eql(nodeDetailAdvancedFixture); }); }); diff --git a/x-pack/test/fleet_api_integration/apis/agents/reassign.ts b/x-pack/test/fleet_api_integration/apis/agents/reassign.ts index 6ba5bbc3b965a..52251a5f40133 100644 --- a/x-pack/test/fleet_api_integration/apis/agents/reassign.ts +++ b/x-pack/test/fleet_api_integration/apis/agents/reassign.ts @@ -16,7 +16,7 @@ export default function (providerContext: FtrProviderContext) { const supertest = getService('supertest'); const supertestWithoutAuth = getService('supertestWithoutAuth'); - describe('reassign agent(s)', () => { + describe('fleet_reassign_agent', () => { before(async () => { await esArchiver.load('x-pack/test/functional/es_archives/fleet/empty_fleet_server'); }); @@ -190,6 +190,7 @@ export default function (providerContext: FtrProviderContext) { policy_id: 'policy2', }) .expect(200); + const { body } = await supertest.get(`/api/fleet/agents`).set('kbn-xsrf', 'xxx'); expect(body.total).to.eql(4); body.items.forEach((agent: any) => { diff --git a/x-pack/test/fleet_api_integration/apis/package_policy/get.ts b/x-pack/test/fleet_api_integration/apis/package_policy/get.ts index 1e90ab76666fe..5c3ed257d7b5e 100644 --- a/x-pack/test/fleet_api_integration/apis/package_policy/get.ts +++ b/x-pack/test/fleet_api_integration/apis/package_policy/get.ts @@ -5,6 +5,7 @@ * 2.0. */ +import expect from '@kbn/expect'; import { FtrProviderContext } from '../../../api_integration/ftr_provider_context'; import { skipIfNoDockerRegistry } from '../../helpers'; @@ -18,10 +19,9 @@ export default function (providerContext: FtrProviderContext) { // because `this` has to point to the Mocha context // see https://mochajs.org/#arrow-functions - describe('Package Policy - get by id', async function () { + describe('Package Policy APIs', () => { skipIfNoDockerRegistry(providerContext); - let agentPolicyId: string; - let packagePolicyId: string; + before(async () => { await getService('esArchiver').load('x-pack/test/functional/es_archives/empty_kibana'); await getService('esArchiver').load( @@ -29,68 +29,146 @@ export default function (providerContext: FtrProviderContext) { ); }); - before(async function () { - if (!server.enabled) { - return; - } - const { body: agentPolicyResponse } = await supertest - .post(`/api/fleet/agent_policies`) - .set('kbn-xsrf', 'xxxx') - .send({ - name: 'Test policy', - namespace: 'default', - }); - agentPolicyId = agentPolicyResponse.item.id; - - const { body: packagePolicyResponse } = await supertest - .post(`/api/fleet/package_policies`) - .set('kbn-xsrf', 'xxxx') - .send({ - name: 'filetest-1', - description: '', - namespace: 'default', - policy_id: agentPolicyId, - enabled: true, - output_id: '', - inputs: [], - package: { - name: 'filetest', - title: 'For File Tests', - version: '0.1.0', - }, - }); - packagePolicyId = packagePolicyResponse.item.id; - }); - - after(async function () { - if (!server.enabled) { - return; - } - - await supertest - .post(`/api/fleet/agent_policies/delete`) - .set('kbn-xsrf', 'xxxx') - .send({ agentPolicyId }) - .expect(200); - - await supertest - .post(`/api/fleet/package_policies/delete`) - .set('kbn-xsrf', 'xxxx') - .send({ packagePolicyIds: [packagePolicyId] }) - .expect(200); - }); after(async () => { await getService('esArchiver').unload( 'x-pack/test/functional/es_archives/fleet/empty_fleet_server' ); await getService('esArchiver').unload('x-pack/test/functional/es_archives/empty_kibana'); }); - it('should succeed with a valid id', async function () { - await supertest.get(`/api/fleet/package_policies/${packagePolicyId}`).expect(200); + + describe('get by id', async function () { + let agentPolicyId: string; + let packagePolicyId: string; + + before(async function () { + if (!server.enabled) { + return; + } + + const { body: agentPolicyResponse } = await supertest + .post(`/api/fleet/agent_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'Test policy', + namespace: 'default', + }); + agentPolicyId = agentPolicyResponse.item.id; + + const { body: packagePolicyResponse } = await supertest + .post(`/api/fleet/package_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'filetest-1', + description: '', + namespace: 'default', + policy_id: agentPolicyId, + enabled: true, + output_id: '', + inputs: [], + package: { + name: 'filetest', + title: 'For File Tests', + version: '0.1.0', + }, + }); + packagePolicyId = packagePolicyResponse.item.id; + }); + + after(async function () { + if (!server.enabled) { + return; + } + + await supertest + .post(`/api/fleet/agent_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ agentPolicyId }) + .expect(200); + + await supertest + .post(`/api/fleet/package_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ packagePolicyIds: [packagePolicyId] }) + .expect(200); + }); + + it('should succeed with a valid id', async function () { + await supertest.get(`/api/fleet/package_policies/${packagePolicyId}`).expect(200); + }); + + it('should return a 404 with an invalid id', async function () { + await supertest.get(`/api/fleet/package_policies/IS_NOT_PRESENT`).expect(404); + }); }); - it('should return a 404 with an invalid id', async function () { - await supertest.get(`/api/fleet/package_policies/IS_NOT_PRESENT`).expect(404); + describe('get orphaned policies', () => { + let agentPolicyId: string; + let packagePolicyId: string; + + before(async function () { + if (!server.enabled) { + return; + } + + const { body: agentPolicyResponse } = await supertest + .post(`/api/fleet/agent_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'Test policy', + namespace: 'default', + }); + + agentPolicyId = agentPolicyResponse.item.id; + + const { body: packagePolicyResponse } = await supertest + .post(`/api/fleet/package_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'filetest-1', + description: '', + namespace: 'default', + policy_id: agentPolicyId, + enabled: true, + output_id: '', + inputs: [], + package: { + name: 'filetest', + title: 'For File Tests', + version: '0.1.0', + }, + }); + + packagePolicyId = packagePolicyResponse.item.id; + + // Delete the agent policy directly from ES to orphan the package policy + const esClient = getService('es'); + await esClient.delete({ + index: '.kibana', + id: `ingest-agent-policies:${agentPolicyId}`, + refresh: 'wait_for', + }); + }); + + after(async function () { + if (!server.enabled) { + return; + } + + await supertest + .post(`/api/fleet/package_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ packagePolicyIds: [packagePolicyId], force: true }) + .expect(200); + }); + + it('should return orphaned policy', async () => { + const response = await supertest + .get('/internal/fleet/orphaned_integration_policies') + .expect(200); + + expect(response.body.items).to.have.length(1); + expect(response.body.items[0].id).to.eql(packagePolicyId); + }); }); }); } diff --git a/x-pack/test/functional/apps/maps/group4/mvt_scaling.js b/x-pack/test/functional/apps/maps/group4/mvt_scaling.js index 5f740e9137cdb..9bc23c8488ab9 100644 --- a/x-pack/test/functional/apps/maps/group4/mvt_scaling.js +++ b/x-pack/test/functional/apps/maps/group4/mvt_scaling.js @@ -53,7 +53,7 @@ export default function ({ getPageObjects, getService }) { hasLabels: 'false', index: 'geo_shapes*', requestBody: - '(_source:!f,docvalue_fields:!(prop1),query:(bool:(filter:!(),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10001,stored_fields:!(geometry,prop1))', + '(_source:!f,fields:!(prop1),query:(bool:(filter:!(),must:!(),must_not:!(),should:!())),runtime_mappings:(),size:10001)', }); }); diff --git a/x-pack/test/functional/apps/ml/anomaly_detection/index.ts b/x-pack/test/functional/apps/ml/anomaly_detection/index.ts index 0b206bfc450f3..60bc92990b905 100644 --- a/x-pack/test/functional/apps/ml/anomaly_detection/index.ts +++ b/x-pack/test/functional/apps/ml/anomaly_detection/index.ts @@ -48,5 +48,6 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./aggregated_scripted_job')); loadTestFile(require.resolve('./custom_urls')); loadTestFile(require.resolve('./forecasts')); + loadTestFile(require.resolve('./lens_to_ml')); }); } diff --git a/x-pack/test/functional/apps/ml/anomaly_detection/lens_to_ml.ts b/x-pack/test/functional/apps/ml/anomaly_detection/lens_to_ml.ts new file mode 100644 index 0000000000000..31964c5144d89 --- /dev/null +++ b/x-pack/test/functional/apps/ml/anomaly_detection/lens_to_ml.ts @@ -0,0 +1,202 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../../../ftr_provider_context'; + +export default function ({ getService, getPageObject, getPageObjects }: FtrProviderContext) { + const ml = getService('ml'); + const dashboardPanelActions = getService('dashboardPanelActions'); + const browser = getService('browser'); + const retry = getService('retry'); + const headerPage = getPageObject('header'); + const PageObjects = getPageObjects(['common', 'timePicker', 'dashboard']); + const kibanaServer = getService('kibanaServer'); + const esArchiver = getService('esArchiver'); + + const dashboardTitle = 'lens_to_ml'; + const dashboardArchive = + 'x-pack/test/functional/fixtures/kbn_archiver/ml/lens_to_ml_dashboard.json'; + + async function retrySwitchTab(tabIndex: number, seconds: number) { + await retry.tryForTime(seconds * 1000, async () => { + await browser.switchTab(tabIndex); + }); + await browser.setWindowSize(1920, 1080); + } + + async function setFarequoteTimerange() { + await PageObjects.timePicker.setAbsoluteRange( + 'Feb 7, 2016 @ 00:00:00.000', + 'Feb 11, 2016 @ 23:59:54.000' + ); + } + + async function dashboardPreparation(selectedPanelTitle: string) { + await PageObjects.dashboard.loadSavedDashboard(dashboardTitle); + await ml.dashboardEmbeddables.assertDashboardPanelExists(selectedPanelTitle); + + await setFarequoteTimerange(); + + const header = await dashboardPanelActions.getPanelHeading(selectedPanelTitle); + await dashboardPanelActions.openContextMenuMorePanel(header); + } + + async function createJobInWizard( + jobId: string, + splitField?: string, + aggAndFieldIdentifier?: string + ) { + await headerPage.waitUntilLoadingHasFinished(); + + if (splitField !== undefined) { + await ml.jobTypeSelection.assertMultiMetricJobWizardOpen(); + await ml.jobWizardMultiMetric.assertDetectorSplitExists(splitField); + await ml.jobWizardCommon.assertInfluencerSelection([splitField]); + } else if (aggAndFieldIdentifier !== undefined) { + await ml.jobTypeSelection.assertSingleMetricJobWizardOpen(); + await ml.jobWizardCommon.assertAggAndFieldInputExists(); + await ml.jobWizardCommon.selectAggAndField(aggAndFieldIdentifier, true); + await ml.jobWizardCommon.assertAnomalyChartExists('LINE'); + } + + await ml.testExecution.logTestStep('job creation displays the job details step'); + await ml.jobWizardCommon.advanceToJobDetailsSection(); + + await ml.testExecution.logTestStep('job creation inputs the job id'); + await ml.jobWizardCommon.assertJobIdInputExists(); + await ml.jobWizardCommon.setJobId(jobId); + + await ml.testExecution.logTestStep('job creation displays the validation step'); + await ml.jobWizardCommon.advanceToValidationSection(); + + await ml.testExecution.logTestStep('job creation displays the summary step'); + await ml.jobWizardCommon.advanceToSummarySection(); + + await ml.testExecution.logTestStep('job creation creates the job and finishes processing'); + await ml.jobWizardCommon.assertCreateJobButtonExists(); + await ml.jobWizardCommon.createJobAndWaitForCompletion(); + + await ml.testExecution.logTestStep('job creation displays the created job in the job list'); + await ml.navigation.navigateToMl(); + await ml.navigation.navigateToJobManagement(); + + await ml.jobTable.filterWithSearchString(jobId, 1); + + await ml.jobTable.assertJobRowJobId(jobId); + } + + describe('create jobs from lens', function () { + this.tags(['ml']); + + before(async () => { + await ml.testResources.setKibanaTimeZoneToUTC(); + await ml.securityUI.loginAsMlPowerUser(); + + await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/ml/farequote'); + await kibanaServer.importExport.load(dashboardArchive); + await browser.setWindowSize(1920, 1080); + }); + + after(async () => { + await ml.api.cleanMlIndices(); + await kibanaServer.importExport.unload(dashboardArchive); + }); + + beforeEach(async () => { + await PageObjects.common.navigateToApp('dashboard'); + }); + + let tabsCount = 1; + + afterEach(async () => { + if (tabsCount > 1) { + await browser.closeCurrentWindow(); + await retrySwitchTab(0, 10); + tabsCount--; + } + }); + + it('can create multi metric job from vis with single layer', async () => { + const selectedPanelTitle = 'panel1'; + const jobId = 'job_from_lens_1'; + const splitField = 'airline'; + + await dashboardPreparation(selectedPanelTitle); + + await ml.lensVisualizations.clickCreateMLJobMenuAction(); + + await retrySwitchTab(1, 10); + tabsCount++; + + await createJobInWizard(jobId, splitField, undefined); + }); + + it('can create single metric job from vis with single layer', async () => { + const selectedPanelTitle = 'panel2'; + const aggAndFieldIdentifier = 'Count(Event rate)'; + const jobId = 'job_from_lens_2'; + + await dashboardPreparation(selectedPanelTitle); + + await ml.lensVisualizations.clickCreateMLJobMenuAction(); + + await retrySwitchTab(1, 10); + tabsCount++; + + await createJobInWizard(jobId, undefined, aggAndFieldIdentifier); + }); + + it('can create multi metric job from vis with multiple compatible layers and single incompatible layer', async () => { + const selectedPanelTitle = 'panel3'; + const aggAndFieldIdentifier = 'Mean(responsetime)'; + const jobId = 'job_from_lens_3'; + const numberOfCompatibleLayers = 2; + const numberOfIncompatibleLayers = 1; + + await dashboardPreparation(selectedPanelTitle); + + await ml.lensVisualizations.clickCreateMLJobMenuAction(); + + await ml.lensVisualizations.assertLensLayerSelectorExists(); + + await ml.lensVisualizations.assertNumberOfCompatibleLensLayers(numberOfCompatibleLayers); + + await ml.lensVisualizations.assertNumberOfIncompatibleLensLayers(numberOfIncompatibleLayers); + + ml.lensVisualizations.clickCreateJobFromLayer(1); + + await retrySwitchTab(1, 10); + tabsCount++; + + await createJobInWizard(jobId, undefined, aggAndFieldIdentifier); + }); + + it('shows flyout for job from vis with no compatible layers', async () => { + const selectedPanelTitle = 'panel4'; + const numberOfCompatibleLayers = 0; + const numberOfIncompatibleLayers = 1; + + await dashboardPreparation(selectedPanelTitle); + + await ml.lensVisualizations.clickCreateMLJobMenuAction(); + + await ml.lensVisualizations.assertLensLayerSelectorExists(); + + await ml.lensVisualizations.assertNumberOfCompatibleLensLayers(numberOfCompatibleLayers); + + await ml.lensVisualizations.assertNumberOfIncompatibleLensLayers(numberOfIncompatibleLayers); + }); + + it('does not show link to ml with vis with only incompatible layer types', async () => { + const selectedPanelTitle = 'panel5'; + + await dashboardPreparation(selectedPanelTitle); + + ml.lensVisualizations.assertMLJobMenuActionDoesNotExist(); + }); + }); +} diff --git a/x-pack/test/functional/fixtures/kbn_archiver/ml/lens_to_ml_dashboard.json b/x-pack/test/functional/fixtures/kbn_archiver/ml/lens_to_ml_dashboard.json new file mode 100644 index 0000000000000..17a02882b2b55 --- /dev/null +++ b/x-pack/test/functional/fixtures/kbn_archiver/ml/lens_to_ml_dashboard.json @@ -0,0 +1,80 @@ +{ + "attributes": { + "fieldAttrs": "{}", + "fields": "[]", + "name": "", + "runtimeFieldMap": "{}", + "timeFieldName": "@timestamp", + "title": "ft_farequote", + "typeMeta": "{}" + }, + "coreMigrationVersion": "8.4.0", + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "migrationVersion": { + "index-pattern": "8.0.0" + }, + "references": [], + "type": "index-pattern", + "updated_at": "2022-06-16T10:32:56.582Z", + "version": "WzU4LDFd" +} + +{ + "attributes": { + "description": "", + "hits": 0, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" + }, + "optionsJSON": "{\"useMargins\":true,\"syncColors\":false,\"syncTooltips\":false,\"hidePanelTitles\":false}", + "panelsJSON": "[{\"version\":\"8.4.0\",\"type\":\"lens\",\"gridData\":{\"x\":0,\"y\":0,\"w\":24,\"h\":9,\"i\":\"ce47cd87-4625-45ae-bf24-0acc847861a3\"},\"panelIndex\":\"ce47cd87-4625-45ae-bf24-0acc847861a3\",\"embeddableConfig\":{\"attributes\":{\"title\":\"\",\"visualizationType\":\"lnsXY\",\"type\":\"lens\",\"references\":[{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-971d994f-71d7-49d9-ab03-5046fb7c516e\"}],\"state\":{\"visualization\":{\"legend\":{\"isVisible\":true,\"position\":\"right\"},\"valueLabels\":\"hide\",\"fittingFunction\":\"None\",\"axisTitlesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"tickLabelsVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"labelsOrientation\":{\"x\":0,\"yLeft\":0,\"yRight\":0},\"gridlinesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"preferredSeriesType\":\"bar_stacked\",\"layers\":[{\"layerId\":\"971d994f-71d7-49d9-ab03-5046fb7c516e\",\"accessors\":[\"d3f232dc-571b-44bb-b8d9-b68931f3ad9e\"],\"position\":\"top\",\"seriesType\":\"bar_stacked\",\"showGridlines\":false,\"layerType\":\"data\",\"xAccessor\":\"0df5cd82-7be0-4683-95d6-a93767063e41\",\"splitAccessor\":\"5fb243c9-62e9-4ed7-a6da-1238588cde66\"}]},\"query\":{\"query\":\"\",\"language\":\"lucene\"},\"filters\":[],\"datasourceStates\":{\"indexpattern\":{\"layers\":{\"971d994f-71d7-49d9-ab03-5046fb7c516e\":{\"columns\":{\"0df5cd82-7be0-4683-95d6-a93767063e41\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"d3f232dc-571b-44bb-b8d9-b68931f3ad9e\":{\"label\":\"Median of responsetime\",\"dataType\":\"number\",\"operationType\":\"median\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"params\":{\"emptyAsNull\":true}},\"5fb243c9-62e9-4ed7-a6da-1238588cde66\":{\"label\":\"Top 10 values of airline\",\"dataType\":\"string\",\"operationType\":\"terms\",\"scale\":\"ordinal\",\"sourceField\":\"airline\",\"isBucketed\":true,\"params\":{\"size\":10,\"orderBy\":{\"type\":\"column\",\"columnId\":\"d3f232dc-571b-44bb-b8d9-b68931f3ad9e\"},\"orderDirection\":\"desc\",\"otherBucket\":true,\"missingBucket\":false,\"parentFormat\":{\"id\":\"terms\"}}}},\"columnOrder\":[\"5fb243c9-62e9-4ed7-a6da-1238588cde66\",\"0df5cd82-7be0-4683-95d6-a93767063e41\",\"d3f232dc-571b-44bb-b8d9-b68931f3ad9e\"],\"incompleteColumns\":{}}}}}}},\"hidePanelTitles\":false,\"enhancements\":{}},\"title\":\"panel1\"},{\"version\":\"8.4.0\",\"type\":\"lens\",\"gridData\":{\"x\":24,\"y\":0,\"w\":24,\"h\":9,\"i\":\"00a8c0c0-7cb2-4828-bbc8-85072acb43f4\"},\"panelIndex\":\"00a8c0c0-7cb2-4828-bbc8-85072acb43f4\",\"embeddableConfig\":{\"attributes\":{\"title\":\"\",\"visualizationType\":\"lnsXY\",\"type\":\"lens\",\"references\":[{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794\"}],\"state\":{\"visualization\":{\"legend\":{\"isVisible\":true,\"position\":\"right\"},\"valueLabels\":\"hide\",\"fittingFunction\":\"None\",\"axisTitlesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"tickLabelsVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"labelsOrientation\":{\"x\":0,\"yLeft\":0,\"yRight\":0},\"gridlinesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"preferredSeriesType\":\"bar_stacked\",\"layers\":[{\"layerId\":\"e85e1a7e-0c55-48f6-8610-4e55566ac794\",\"accessors\":[\"1953cd9b-5ab7-4770-9e14-38065b0e2e6d\"],\"position\":\"top\",\"seriesType\":\"bar_stacked\",\"showGridlines\":false,\"layerType\":\"data\",\"xAccessor\":\"d123e2a3-2673-4979-a654-1e9bdf8c860c\"}]},\"query\":{\"query\":\"\",\"language\":\"lucene\"},\"filters\":[],\"datasourceStates\":{\"indexpattern\":{\"layers\":{\"e85e1a7e-0c55-48f6-8610-4e55566ac794\":{\"columns\":{\"d123e2a3-2673-4979-a654-1e9bdf8c860c\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"1953cd9b-5ab7-4770-9e14-38065b0e2e6d\":{\"label\":\"Count of records\",\"dataType\":\"number\",\"operationType\":\"count\",\"isBucketed\":false,\"scale\":\"ratio\",\"sourceField\":\"___records___\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"d123e2a3-2673-4979-a654-1e9bdf8c860c\",\"1953cd9b-5ab7-4770-9e14-38065b0e2e6d\"],\"incompleteColumns\":{}}}}}}},\"hidePanelTitles\":false,\"enhancements\":{}},\"title\":\"panel2\"},{\"version\":\"8.4.0\",\"type\":\"lens\",\"gridData\":{\"x\":0,\"y\":9,\"w\":24,\"h\":10,\"i\":\"ba0e5dfa-6557-4553-a604-8efba7e1dec7\"},\"panelIndex\":\"ba0e5dfa-6557-4553-a604-8efba7e1dec7\",\"embeddableConfig\":{\"attributes\":{\"title\":\"\",\"visualizationType\":\"lnsXY\",\"type\":\"lens\",\"references\":[{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794\"},{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-b71cc247-df37-4af9-8f74-5d57d3d0f601\"},{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-4b6c7494-5bb4-4934-8259-498c499afc49\"}],\"state\":{\"visualization\":{\"legend\":{\"isVisible\":true,\"position\":\"right\"},\"valueLabels\":\"hide\",\"fittingFunction\":\"None\",\"axisTitlesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"tickLabelsVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"labelsOrientation\":{\"x\":0,\"yLeft\":0,\"yRight\":0},\"gridlinesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"preferredSeriesType\":\"bar_stacked\",\"layers\":[{\"layerId\":\"e85e1a7e-0c55-48f6-8610-4e55566ac794\",\"accessors\":[\"ac862e79-e190-4683-8ce2-190d19739d0b\"],\"position\":\"top\",\"seriesType\":\"bar_stacked\",\"showGridlines\":false,\"layerType\":\"data\",\"xAccessor\":\"d123e2a3-2673-4979-a654-1e9bdf8c860c\"},{\"layerId\":\"b71cc247-df37-4af9-8f74-5d57d3d0f601\",\"layerType\":\"data\",\"accessors\":[\"6a30ac94-8136-4a9a-ad82-406e4f356fef\"],\"seriesType\":\"line\",\"xAccessor\":\"cba5843a-cc04-47c3-a5b3-be50a6e0e8f8\"},{\"layerId\":\"5a095ef4-ef79-40fd-9f4f-903569043e83\",\"layerType\":\"annotations\",\"annotations\":[{\"label\":\"Event\",\"key\":{\"type\":\"point_in_time\",\"timestamp\":\"2016-02-09T10:30:00.000Z\"},\"icon\":\"triangle\",\"id\":\"11fabbec-d314-433f-bf98-52ef2a165a66\"}]},{\"layerId\":\"4b6c7494-5bb4-4934-8259-498c499afc49\",\"layerType\":\"data\",\"accessors\":[\"a5274ae1-c2c8-47a8-9ffa-8b0192aa540f\"],\"seriesType\":\"line\",\"xAccessor\":\"f89f9e12-9ae7-46de-a559-66194a44ee71\"}]},\"query\":{\"query\":\"\",\"language\":\"lucene\"},\"filters\":[],\"datasourceStates\":{\"indexpattern\":{\"layers\":{\"e85e1a7e-0c55-48f6-8610-4e55566ac794\":{\"columns\":{\"d123e2a3-2673-4979-a654-1e9bdf8c860c\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"ac862e79-e190-4683-8ce2-190d19739d0b\":{\"label\":\"Median of responsetime\",\"dataType\":\"number\",\"operationType\":\"median\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"d123e2a3-2673-4979-a654-1e9bdf8c860c\",\"ac862e79-e190-4683-8ce2-190d19739d0b\"],\"incompleteColumns\":{}},\"b71cc247-df37-4af9-8f74-5d57d3d0f601\":{\"columns\":{\"cba5843a-cc04-47c3-a5b3-be50a6e0e8f8\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"6a30ac94-8136-4a9a-ad82-406e4f356fef\":{\"label\":\"Average of responsetime\",\"dataType\":\"number\",\"operationType\":\"average\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"cba5843a-cc04-47c3-a5b3-be50a6e0e8f8\",\"6a30ac94-8136-4a9a-ad82-406e4f356fef\"],\"incompleteColumns\":{}},\"4b6c7494-5bb4-4934-8259-498c499afc49\":{\"columns\":{\"f89f9e12-9ae7-46de-a559-66194a44ee71\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"a5274ae1-c2c8-47a8-9ffa-8b0192aa540f\":{\"label\":\"Average of responsetime -3h\",\"dataType\":\"number\",\"operationType\":\"average\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"timeShift\":\"3h\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"f89f9e12-9ae7-46de-a559-66194a44ee71\",\"a5274ae1-c2c8-47a8-9ffa-8b0192aa540f\"],\"incompleteColumns\":{}}}}}}},\"hidePanelTitles\":false,\"enhancements\":{}},\"title\":\"panel3\"},{\"version\":\"8.4.0\",\"type\":\"lens\",\"gridData\":{\"x\":24,\"y\":9,\"w\":24,\"h\":10,\"i\":\"099d1917-72cb-4e98-bbe8-404ce1b8ea78\"},\"panelIndex\":\"099d1917-72cb-4e98-bbe8-404ce1b8ea78\",\"embeddableConfig\":{\"attributes\":{\"title\":\"\",\"visualizationType\":\"lnsXY\",\"type\":\"lens\",\"references\":[{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794\"}],\"state\":{\"visualization\":{\"legend\":{\"isVisible\":true,\"position\":\"right\"},\"valueLabels\":\"hide\",\"fittingFunction\":\"None\",\"axisTitlesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"tickLabelsVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"labelsOrientation\":{\"x\":0,\"yLeft\":0,\"yRight\":0},\"gridlinesVisibilitySettings\":{\"x\":true,\"yLeft\":true,\"yRight\":true},\"preferredSeriesType\":\"bar_stacked\",\"layers\":[{\"layerId\":\"e85e1a7e-0c55-48f6-8610-4e55566ac794\",\"accessors\":[\"ef8bebb0-1b26-4ec4-afc5-92147cd47680\"],\"position\":\"top\",\"seriesType\":\"bar_stacked\",\"showGridlines\":false,\"layerType\":\"data\",\"xAccessor\":\"d123e2a3-2673-4979-a654-1e9bdf8c860c\"}]},\"query\":{\"query\":\"\",\"language\":\"lucene\"},\"filters\":[],\"datasourceStates\":{\"indexpattern\":{\"layers\":{\"e85e1a7e-0c55-48f6-8610-4e55566ac794\":{\"columns\":{\"d123e2a3-2673-4979-a654-1e9bdf8c860c\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"ef8bebb0-1b26-4ec4-afc5-92147cd47680\":{\"label\":\"Median of responsetime -1h\",\"dataType\":\"number\",\"operationType\":\"median\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"timeShift\":\"1h\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"d123e2a3-2673-4979-a654-1e9bdf8c860c\",\"ef8bebb0-1b26-4ec4-afc5-92147cd47680\"],\"incompleteColumns\":{}}}}}}},\"hidePanelTitles\":false,\"enhancements\":{}},\"title\":\"panel4\"},{\"version\":\"8.4.0\",\"type\":\"lens\",\"gridData\":{\"x\":0,\"y\":19,\"w\":24,\"h\":10,\"i\":\"1d4fdecd-fe7c-44d8-908d-e9448999915c\"},\"panelIndex\":\"1d4fdecd-fe7c-44d8-908d-e9448999915c\",\"embeddableConfig\":{\"attributes\":{\"title\":\"\",\"visualizationType\":\"lnsDatatable\",\"type\":\"lens\",\"references\":[{\"type\":\"index-pattern\",\"id\":\"af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0\",\"name\":\"indexpattern-datasource-layer-208abf63-5927-4660-bbc7-bb3e5174911b\"}],\"state\":{\"visualization\":{\"columns\":[{\"isTransposed\":false,\"columnId\":\"d411f774-5bf6-4fef-85bb-d748d8c2ce25\"},{\"isTransposed\":false,\"columnId\":\"d1ddc948-8ed3-4caa-9993-b5e6786a742b\"}],\"layerId\":\"208abf63-5927-4660-bbc7-bb3e5174911b\",\"layerType\":\"data\"},\"query\":{\"query\":\"\",\"language\":\"lucene\"},\"filters\":[],\"datasourceStates\":{\"indexpattern\":{\"layers\":{\"208abf63-5927-4660-bbc7-bb3e5174911b\":{\"columns\":{\"d411f774-5bf6-4fef-85bb-d748d8c2ce25\":{\"label\":\"@timestamp\",\"dataType\":\"date\",\"operationType\":\"date_histogram\",\"sourceField\":\"@timestamp\",\"isBucketed\":true,\"scale\":\"interval\",\"params\":{\"interval\":\"auto\",\"includeEmptyRows\":true,\"dropPartials\":false}},\"d1ddc948-8ed3-4caa-9993-b5e6786a742b\":{\"label\":\"Median of responsetime\",\"dataType\":\"number\",\"operationType\":\"median\",\"sourceField\":\"responsetime\",\"isBucketed\":false,\"scale\":\"ratio\",\"params\":{\"emptyAsNull\":true}}},\"columnOrder\":[\"d411f774-5bf6-4fef-85bb-d748d8c2ce25\",\"d1ddc948-8ed3-4caa-9993-b5e6786a742b\"],\"incompleteColumns\":{}}}}}}},\"hidePanelTitles\":false,\"enhancements\":{}},\"title\":\"panel5\"}]", + "timeRestore": false, + "title": "lens_to_ml", + "version": 1 + }, + "coreMigrationVersion": "8.4.0", + "id": "210cd820-ed71-11ec-937e-3d81e6f9d3c0", + "migrationVersion": { + "dashboard": "8.3.0" + }, + "references": [ + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "ce47cd87-4625-45ae-bf24-0acc847861a3:indexpattern-datasource-layer-971d994f-71d7-49d9-ab03-5046fb7c516e", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "00a8c0c0-7cb2-4828-bbc8-85072acb43f4:indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "ba0e5dfa-6557-4553-a604-8efba7e1dec7:indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "ba0e5dfa-6557-4553-a604-8efba7e1dec7:indexpattern-datasource-layer-b71cc247-df37-4af9-8f74-5d57d3d0f601", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "ba0e5dfa-6557-4553-a604-8efba7e1dec7:indexpattern-datasource-layer-4b6c7494-5bb4-4934-8259-498c499afc49", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "099d1917-72cb-4e98-bbe8-404ce1b8ea78:indexpattern-datasource-layer-e85e1a7e-0c55-48f6-8610-4e55566ac794", + "type": "index-pattern" + }, + { + "id": "af9fbc40-ed5f-11ec-937e-3d81e6f9d3c0", + "name": "1d4fdecd-fe7c-44d8-908d-e9448999915c:indexpattern-datasource-layer-208abf63-5927-4660-bbc7-bb3e5174911b", + "type": "index-pattern" + } + ], + "type": "dashboard", + "updated_at": "2022-06-16T15:33:11.482Z", + "version": "Wzc5OCwxXQ==" +} \ No newline at end of file diff --git a/x-pack/test/functional/services/ml/index.ts b/x-pack/test/functional/services/ml/index.ts index 42cde18079aab..e4dd0b4bdeeb7 100644 --- a/x-pack/test/functional/services/ml/index.ts +++ b/x-pack/test/functional/services/ml/index.ts @@ -36,6 +36,7 @@ import { MachineLearningJobWizardCommonProvider } from './job_wizard_common'; import { MachineLearningJobWizardCategorizationProvider } from './job_wizard_categorization'; import { MachineLearningJobWizardMultiMetricProvider } from './job_wizard_multi_metric'; import { MachineLearningJobWizardPopulationProvider } from './job_wizard_population'; +import { MachineLearningLensVisualizationsProvider } from './lens_visualizations'; import { MachineLearningNavigationProvider } from './navigation'; import { MachineLearningOverviewPageProvider } from './overview_page'; import { MachineLearningSecurityCommonProvider } from './security_common'; @@ -109,6 +110,7 @@ export function MachineLearningProvider(context: FtrProviderContext) { const jobWizardCommon = MachineLearningJobWizardCommonProvider(context, commonUI, customUrls); const jobWizardMultiMetric = MachineLearningJobWizardMultiMetricProvider(context); const jobWizardPopulation = MachineLearningJobWizardPopulationProvider(context); + const lensVisualizations = MachineLearningLensVisualizationsProvider(context); const navigation = MachineLearningNavigationProvider(context); const overviewPage = MachineLearningOverviewPageProvider(context); const securityCommon = MachineLearningSecurityCommonProvider(context); @@ -165,6 +167,7 @@ export function MachineLearningProvider(context: FtrProviderContext) { jobWizardCommon, jobWizardMultiMetric, jobWizardPopulation, + lensVisualizations, navigation, overviewPage, securityCommon, diff --git a/x-pack/test/functional/services/ml/job_table.ts b/x-pack/test/functional/services/ml/job_table.ts index 000cd04e9d7ac..fe60073bd3a33 100644 --- a/x-pack/test/functional/services/ml/job_table.ts +++ b/x-pack/test/functional/services/ml/job_table.ts @@ -279,6 +279,15 @@ export function MachineLearningJobTableProvider( }); } + public async assertJobRowJobId(jobId: string) { + await retry.tryForTime(5000, async () => { + await this.refreshJobList(); + const rows = await this.parseJobTable(); + const jobRowMatch = rows.find((row) => row.id === jobId); + expect(jobRowMatch).to.not.eql(undefined, `Expected row with job ID ${jobId} to exist`); + }); + } + public async assertJobRowDetailsCounts( jobId: string, expectedCounts: object, diff --git a/x-pack/test/functional/services/ml/lens_visualizations.ts b/x-pack/test/functional/services/ml/lens_visualizations.ts new file mode 100644 index 0000000000000..3c05ec234a3c2 --- /dev/null +++ b/x-pack/test/functional/services/ml/lens_visualizations.ts @@ -0,0 +1,42 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export function MachineLearningLensVisualizationsProvider({ getService }: FtrProviderContext) { + const testSubjects = getService('testSubjects'); + + return { + async clickCreateMLJobMenuAction() { + await testSubjects.click('embeddablePanelAction-create-ml-ad-job-action'); + }, + async clickCreateJobFromLayer(layerIndex: number) { + await testSubjects.click(`mlLensLayerCompatibleButton_${layerIndex}`); + }, + async assertLensLayerSelectorExists() { + await testSubjects.existOrFail('mlFlyoutLensLayerSelector'); + }, + async assertMLJobMenuActionDoesNotExist() { + await testSubjects.missingOrFail('embeddablePanelAction-create-ml-ad-job-action'); + }, + async assertNumberOfCompatibleLensLayers(numberOfCompatibleLayers: number) { + const compatibleLayers = await testSubjects.findAll('mlLensLayerCompatible'); + expect(compatibleLayers.length).to.eql( + numberOfCompatibleLayers, + `Expected number of compatible layers to be ${numberOfCompatibleLayers} (got '${compatibleLayers.length}')` + ); + }, + async assertNumberOfIncompatibleLensLayers(numberOfIncompatibleLayers: number) { + const incompatibleLayers = await testSubjects.findAll('mlLensLayerIncompatible'); + expect(incompatibleLayers.length).to.eql( + numberOfIncompatibleLayers, + `Expected number of compatible layers to be ${numberOfIncompatibleLayers} (got '${incompatibleLayers.length}')` + ); + }, + }; +} diff --git a/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts b/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts index 1a009aaef07ec..c0b15090cda1e 100644 --- a/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts +++ b/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts @@ -6,6 +6,19 @@ */ import { wrapErrorAndRejectPromise } from '@kbn/security-solution-plugin/common/endpoint/data_loaders/utils'; +import { + ACTION_STATUS_ROUTE, + AGENT_POLICY_SUMMARY_ROUTE, + BASE_POLICY_RESPONSE_ROUTE, + GET_RUNNING_PROCESSES_ROUTE, + HOST_METADATA_LIST_ROUTE, + ISOLATE_HOST_ROUTE, + ISOLATE_HOST_ROUTE_V2, + KILL_PROCESS_ROUTE, + SUSPEND_PROCESS_ROUTE, + UNISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, +} from '@kbn/security-solution-plugin/common/endpoint/constants'; import { FtrProviderContext } from '../ftr_provider_context'; import { createUserAndRole, @@ -30,17 +43,17 @@ export default function ({ getService }: FtrProviderContext) { const apiList = [ { method: 'get', - path: '/api/endpoint/metadata', + path: HOST_METADATA_LIST_ROUTE, body: undefined, }, { method: 'get', - path: '/api/endpoint/action_status?agent_ids=1', + path: `${ACTION_STATUS_ROUTE}?agent_ids=1`, body: undefined, }, { method: 'get', - path: '/api/endpoint/policy/summaries?package_name=endpoint', + path: `${AGENT_POLICY_SUMMARY_ROUTE}?package_name=endpoint`, body: undefined, }, { @@ -50,19 +63,44 @@ export default function ({ getService }: FtrProviderContext) { }, { method: 'get', - path: '/api/endpoint/policy_response?agentId=1', + path: `${BASE_POLICY_RESPONSE_ROUTE}?agentId=1`, body: undefined, }, { method: 'post', - path: '/api/endpoint/isolate', + path: ISOLATE_HOST_ROUTE, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: UNISOLATE_HOST_ROUTE, body: { endpoint_ids: ['one'] }, }, { method: 'post', - path: '/api/endpoint/unisolate', + path: ISOLATE_HOST_ROUTE_V2, body: { endpoint_ids: ['one'] }, }, + { + method: 'post', + path: UNISOLATE_HOST_ROUTE_V2, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: GET_RUNNING_PROCESSES_ROUTE, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: KILL_PROCESS_ROUTE, + body: { endpoint_ids: ['one'], parameters: { entity_id: 1234 } }, + }, + { + method: 'post', + path: SUSPEND_PROCESS_ROUTE, + body: { endpoint_ids: ['one'], parameters: { entity_id: 1234 } }, + }, ]; for (const apiListItem of apiList) { diff --git a/yarn.lock b/yarn.lock index 7d5e89b4f0ea7..2d8dde05811f5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3351,6 +3351,10 @@ version "0.0.0" uid "" +"@kbn/shared-ux-card-no-data@link:bazel-bin/packages/shared-ux/card/no_data": + version "0.0.0" + uid "" + "@kbn/shared-ux-components@link:bazel-bin/packages/kbn-shared-ux-components": version "0.0.0" uid "" @@ -3375,6 +3379,10 @@ version "0.0.0" uid "" +"@kbn/shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar": + version "0.0.0" + uid "" + "@kbn/shared-ux-storybook@link:bazel-bin/packages/kbn-shared-ux-storybook": version "0.0.0" uid "" @@ -6718,6 +6726,10 @@ version "0.0.0" uid "" +"@types/kbn__shared-ux-card-no-data@link:bazel-bin/packages/shared-ux/card/no_data/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__shared-ux-components@link:bazel-bin/packages/kbn-shared-ux-components/npm_module_types": version "0.0.0" uid "" @@ -6742,6 +6754,10 @@ version "0.0.0" uid "" +"@types/kbn__shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__shared-ux-storybook@link:bazel-bin/packages/kbn-shared-ux-storybook/npm_module_types": version "0.0.0" uid ""