From 5446d8ab8c288cb8f0058778fadbdf6a806f1477 Mon Sep 17 00:00:00 2001 From: Coen Warmer Date: Wed, 21 Feb 2024 16:25:46 +0100 Subject: [PATCH] Update references --- .buildkite/ftr_configs.yml | 4 +- .../pipelines/on_merge_unsupported_ftrs.yml | 2 +- .../pull_request/synthetics_plugin.yml | 2 +- .../pipelines/pull_request/uptime_plugin.yml | 2 +- .eslintrc.js | 8 +- .github/CODEOWNERS | 2 +- .github/paths-labeller.yml | 46 +- api_docs/alerting.devdocs.json | 1458 ++++---------- api_docs/deprecations_by_plugin.mdx | 12 +- api_docs/discover.devdocs.json | 464 ++--- api_docs/kbn_core_http_server.devdocs.json | 1175 +++-------- ...kbn_core_saved_objects_server.devdocs.json | 1751 +++++------------ api_docs/kibana_react.devdocs.json | 40 +- api_docs/telemetry.devdocs.json | 218 +- docs/developer/plugin-list.asciidoc | 4 +- package.json | 2 +- .../styled_components_files.js | 2 +- ...get_i18n_identifier_from_file_path.test.ts | 2 +- tsconfig.base.json | 4 +- x-pack/.i18nrc.json | 2 +- .../synthetics/.buildkite/pipelines/flaky.sh | 2 +- .../synthetics/README.md | 2 +- .../synthetics/e2e/README.md | 4 +- .../synthetics/jest.config.js | 9 +- .../uptime/.buildkite/pipelines/flaky.sh | 2 +- x-pack/plugins/uptime/README.md | 2 +- x-pack/plugins/uptime/e2e/README.md | 4 +- yarn.lock | 2 +- 28 files changed, 1347 insertions(+), 3880 deletions(-) diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index eabff5152596..56d085c35218 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -58,9 +58,9 @@ disabled: - x-pack/plugins/profiling/e2e/ftr_config.ts # Elastic Synthetics configs - - x-pack/plugins/synthetics/e2e/config.ts + - x-pack/plugins/observability_solution/synthetics/e2e/config.ts - x-pack/plugins/uptime/e2e/uptime/synthetics_run.ts - - x-pack/plugins/synthetics/e2e/synthetics/synthetics_run.ts + - x-pack/plugins/observability_solution/synthetics/e2e/synthetics/synthetics_run.ts - x-pack/plugins/ux/e2e/synthetics_run.ts - x-pack/plugins/exploratory_view/e2e/synthetics_run.ts diff --git a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml index bf606f2e5abd..b3ef0780f73e 100644 --- a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml +++ b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml @@ -54,7 +54,7 @@ steps: depends_on: build timeout_in_minutes: 120 artifact_paths: - - 'x-pack/plugins/synthetics/e2e/.journeys/**/*' + - 'x-pack/plugins/observability_solution/synthetics/e2e/.journeys/**/*' retry: automatic: - exit_status: '-1' diff --git a/.buildkite/pipelines/pull_request/synthetics_plugin.yml b/.buildkite/pipelines/pull_request/synthetics_plugin.yml index f81a19d835bd..fe6fb1bb0b94 100644 --- a/.buildkite/pipelines/pull_request/synthetics_plugin.yml +++ b/.buildkite/pipelines/pull_request/synthetics_plugin.yml @@ -8,7 +8,7 @@ steps: - quick_checks timeout_in_minutes: 60 artifact_paths: - - 'x-pack/plugins/synthetics/e2e/.journeys/**/*' + - 'x-pack/plugins/observability_solution/synthetics/e2e/.journeys/**/*' retry: automatic: - exit_status: '-1' diff --git a/.buildkite/pipelines/pull_request/uptime_plugin.yml b/.buildkite/pipelines/pull_request/uptime_plugin.yml index c1744101b018..9371fb6c3deb 100644 --- a/.buildkite/pipelines/pull_request/uptime_plugin.yml +++ b/.buildkite/pipelines/pull_request/uptime_plugin.yml @@ -8,7 +8,7 @@ steps: - quick_checks timeout_in_minutes: 60 artifact_paths: - - 'x-pack/plugins/synthetics/e2e/.journeys/**/*' + - 'x-pack/plugins/observability_solution/synthetics/e2e/.journeys/**/*' retry: automatic: - exit_status: '-1' diff --git a/.eslintrc.js b/.eslintrc.js index f3a4fcf6ecc0..8d38ff077dc0 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -919,7 +919,7 @@ module.exports = { 'x-pack/plugins/observability_onboarding/**/*.tsx', 'x-pack/plugins/observability_shared/**/*.tsx', 'x-pack/plugins/profiling/**/*.tsx', - 'x-pack/plugins/synthetics/**/*.tsx', + 'x-pack/plugins/observability_solution/synthetics/**/*.tsx', 'x-pack/plugins/ux/**/*.tsx', 'src/plugins/ai_assistant_management/**/*.tsx', ], @@ -937,7 +937,7 @@ module.exports = { 'x-pack/plugins/observability_onboarding/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', 'x-pack/plugins/observability_shared/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', 'x-pack/plugins/profiling/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', - 'x-pack/plugins/synthetics/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', + 'x-pack/plugins/observability_solution/synthetics/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', 'x-pack/plugins/ux/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', 'src/plugins/ai_assistant_management/**/!(*.stories.tsx|*.test.tsx|*.storybook_decorator.tsx|*.mock.tsx)', ], @@ -971,7 +971,9 @@ module.exports = { }, { // disable imports from legacy uptime plugin - files: ['x-pack/plugins/synthetics/public/apps/synthetics/**/*.{js,mjs,ts,tsx}'], + files: [ + 'x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/**/*.{js,mjs,ts,tsx}', + ], rules: { 'no-restricted-imports': [ 'error', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 8bbe6945d97a..f4e917356812 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -790,7 +790,7 @@ test/server_integration/plugins/status_plugin_b @elastic/kibana-core packages/kbn-std @elastic/kibana-core packages/kbn-stdio-dev-helpers @elastic/kibana-operations packages/kbn-storybook @elastic/kibana-operations -x-pack/plugins/synthetics @elastic/obs-ux-infra_services-team +x-pack/plugins/observability_solution/synthetics @elastic/obs-ux-infra_services-team x-pack/test/alerting_api_integration/common/plugins/task_manager_fixture @elastic/response-ops x-pack/test/plugin_api_perf/plugins/task_manager_performance @elastic/response-ops x-pack/plugins/task_manager @elastic/response-ops diff --git a/.github/paths-labeller.yml b/.github/paths-labeller.yml index 5f1ac0401ab3..bceeb809421d 100644 --- a/.github/paths-labeller.yml +++ b/.github/paths-labeller.yml @@ -1,24 +1,24 @@ --- - - "Feature:Embedding": - - "src/plugins/embeddable/**/*.*" - - "src/plugins/dashboard_embeddable_container/**/*.*" - - "Feature:Drilldowns": - - "x-pack/plugins/drilldowns/**/*.*" - - "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/**/*.*" - - "Feature:ExpressionLanguage": - - "src/plugins/expressions/**/*.*" - - "src/plugins/bfetch/**/*.*" - - "Team:obs-ux-infra_services": - - "x-pack/plugins/apm/**/*.*" - - "x-pack/test/apm_api_integration/**/*.*" - - "packages/kbn-apm-synthtrace/**/*.*" - - "packages/kbn-apm-synthtrace-client/**/*.*" - - "packages/kbn-apm-utils/**/*.*" - - "x-pack/plugins/synthetics/**/*.*" - - "x-pack/plugins/ux/**/*.*" - - "x-pack/plugins/observability/public/components/shared/exploratory_view/**/*.*" - - "Team:Fleet": - - "x-pack/plugins/fleet/**/*.*" - - "x-pack/test/fleet_api_integration/**/*.*" - - "Team:obs-ux-management": - - "x-pack/plugins/observability/**/*.*" +- 'Feature:Embedding': + - 'src/plugins/embeddable/**/*.*' + - 'src/plugins/dashboard_embeddable_container/**/*.*' +- 'Feature:Drilldowns': + - 'x-pack/plugins/drilldowns/**/*.*' + - 'x-pack/plugins/dashboard_enhanced/public/services/drilldowns/**/*.*' +- 'Feature:ExpressionLanguage': + - 'src/plugins/expressions/**/*.*' + - 'src/plugins/bfetch/**/*.*' +- 'Team:obs-ux-infra_services': + - 'x-pack/plugins/apm/**/*.*' + - 'x-pack/test/apm_api_integration/**/*.*' + - 'packages/kbn-apm-synthtrace/**/*.*' + - 'packages/kbn-apm-synthtrace-client/**/*.*' + - 'packages/kbn-apm-utils/**/*.*' + - 'x-pack/plugins/observability_solution/synthetics/**/*.*' + - 'x-pack/plugins/ux/**/*.*' + - 'x-pack/plugins/observability/public/components/shared/exploratory_view/**/*.*' +- 'Team:Fleet': + - 'x-pack/plugins/fleet/**/*.*' + - 'x-pack/test/fleet_api_integration/**/*.*' +- 'Team:obs-ux-management': + - 'x-pack/plugins/observability/**/*.*' diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index b2f0059d0f5d..6251a02afcfe 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -39,9 +39,7 @@ "type": "CompoundType", "tags": [], "label": "rule", - "description": [ - "The rule to view" - ], + "description": ["The rule to view"], "signature": [ "Omit<", { @@ -85,10 +83,7 @@ "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation", "type": "Function", - "tags": [ - "throws", - "deprecated" - ], + "tags": ["throws", "deprecated"], "label": "registerNavigation", "description": [ "\nRegister a customized view of the particular rule type. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n" @@ -143,9 +138,7 @@ "description": [ "The application id that the user should be navigated to, to view a particular rule in a custom way." ], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -160,9 +153,7 @@ "description": [ "The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more." ], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -198,9 +189,7 @@ "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerDefaultNavigation", "type": "Function", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "registerDefaultNavigation", "description": [ "\nRegister a customized view for all rule types with this application id. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n" @@ -230,9 +219,7 @@ "description": [ "The application id that the user should be navigated to, to view a particular rule in a custom way." ], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -286,9 +273,7 @@ "tags": [], "label": "getNavigation", "description": [], - "signature": [ - "(ruleId: string) => Promise" - ], + "signature": ["(ruleId: string) => Promise"], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -300,9 +285,7 @@ "tags": [], "label": "ruleId", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -336,9 +319,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -350,9 +331,7 @@ "tags": [], "label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n getSpace,\n getSpaceId,\n }", "description": [], - "signature": [ - "ConstructorOptions" - ], + "signature": ["ConstructorOptions"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -368,9 +347,7 @@ "tags": [], "label": "getSpaceId", "description": [], - "signature": [ - "() => string | undefined" - ], + "signature": ["() => string | undefined"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -424,9 +401,7 @@ "tags": [], "label": "featureIds", "description": [], - "signature": [ - "readonly string[]" - ], + "signature": ["readonly string[]"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -510,9 +485,7 @@ "tags": [], "label": "{\n ruleTypeId,\n consumer: legacyConsumer,\n operation,\n entity,\n }", "description": [], - "signature": [ - "EnsureAuthorizedOpts" - ], + "signature": ["EnsureAuthorizedOpts"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -589,9 +562,7 @@ "tags": [], "label": "filterOpts", "description": [], - "signature": [ - "AlertingAuthorizationFilterOpts" - ], + "signature": ["AlertingAuthorizationFilterOpts"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -604,9 +575,7 @@ "tags": [], "label": "featuresIds", "description": [], - "signature": [ - "Set | undefined" - ], + "signature": ["Set | undefined"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -667,9 +636,7 @@ "tags": [], "label": "featuresIds", "description": [], - "signature": [ - "Set | undefined" - ], + "signature": ["Set | undefined"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -762,9 +729,7 @@ "tags": [], "label": "filterOpts", "description": [], - "signature": [ - "AlertingAuthorizationFilterOpts" - ], + "signature": ["AlertingAuthorizationFilterOpts"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -806,9 +771,7 @@ "tags": [], "label": "featuresIds", "description": [], - "signature": [ - "Set | undefined" - ], + "signature": ["Set | undefined"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -866,11 +829,7 @@ "tags": [], "label": "ruleTypes", "description": [], - "signature": [ - "Set<", - "RegistryRuleType", - ">" - ], + "signature": ["Set<", "RegistryRuleType", ">"], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "trackAdoption": false, @@ -962,9 +921,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client_error.ts", "deprecated": false, "trackAdoption": false, @@ -1002,9 +959,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts", "deprecated": false, "trackAdoption": false, @@ -1025,11 +980,7 @@ "description": [ "\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template." ], - "signature": [ - "(opts: ", - "CreateConcreteWriteIndexOpts", - ") => Promise" - ], + "signature": ["(opts: ", "CreateConcreteWriteIndexOpts", ") => Promise"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts", "deprecated": false, "trackAdoption": false, @@ -1041,9 +992,7 @@ "tags": [], "label": "opts", "description": [], - "signature": [ - "CreateConcreteWriteIndexOpts" - ], + "signature": ["CreateConcreteWriteIndexOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts", "deprecated": false, "trackAdoption": false, @@ -1074,9 +1023,7 @@ "tags": [], "label": "{\n logger,\n esClient,\n template,\n totalFieldsLimit,\n}", "description": [], - "signature": [ - "CreateOrUpdateComponentTemplateOpts" - ], + "signature": ["CreateOrUpdateComponentTemplateOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_component_template.ts", "deprecated": false, "trackAdoption": false, @@ -1092,9 +1039,7 @@ "type": "Function", "tags": [], "label": "createOrUpdateIlmPolicy", - "description": [ - "\nCreates ILM policy if it doesn't already exist, updates it if it does" - ], + "description": ["\nCreates ILM policy if it doesn't already exist, updates it if it does"], "signature": [ "({ logger, esClient, name, policy, dataStreamAdapter, }: CreateOrUpdateIlmPolicyOpts) => Promise" ], @@ -1109,9 +1054,7 @@ "tags": [], "label": "{\n logger,\n esClient,\n name,\n policy,\n dataStreamAdapter,\n}", "description": [], - "signature": [ - "CreateOrUpdateIlmPolicyOpts" - ], + "signature": ["CreateOrUpdateIlmPolicyOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts", "deprecated": false, "trackAdoption": false, @@ -1144,9 +1087,7 @@ "tags": [], "label": "{\n logger,\n esClient,\n template,\n}", "description": [], - "signature": [ - "CreateOrUpdateIndexTemplateOpts" - ], + "signature": ["CreateOrUpdateIndexTemplateOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", "deprecated": false, "trackAdoption": false, @@ -1178,9 +1119,7 @@ "tags": [], "label": "{\n fieldMap,\n context,\n name,\n dynamic,\n includeSettings,\n}", "description": [], - "signature": [ - "GetComponentTemplateOpts" - ], + "signature": ["GetComponentTemplateOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/resource_installer_utils.ts", "deprecated": false, "trackAdoption": false, @@ -1220,9 +1159,7 @@ "tags": [], "label": "opts", "description": [], - "signature": [ - "GetDataStreamAdapterOpts" - ], + "signature": ["GetDataStreamAdapterOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1239,11 +1176,7 @@ "tags": [], "label": "getEsErrorMessage", "description": [], - "signature": [ - "(error: ", - "ElasticsearchError", - ") => string" - ], + "signature": ["(error: ", "ElasticsearchError", ") => string"], "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", "deprecated": false, "trackAdoption": false, @@ -1255,9 +1188,7 @@ "tags": [], "label": "error", "description": [], - "signature": [ - "ElasticsearchError" - ], + "signature": ["ElasticsearchError"], "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", "deprecated": false, "trackAdoption": false, @@ -1289,9 +1220,7 @@ "tags": [], "label": "{\n componentTemplateRefs,\n ilmPolicyName,\n indexPatterns,\n kibanaVersion,\n namespace,\n totalFieldsLimit,\n dataStreamAdapter,\n}", "description": [], - "signature": [ - "GetIndexTemplateOpts" - ], + "signature": ["GetIndexTemplateOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", "deprecated": false, "trackAdoption": false, @@ -1322,9 +1251,7 @@ "tags": [], "label": "{\n description,\n installFn,\n pluginStop$,\n logger,\n timeoutMs = INSTALLATION_TIMEOUT,\n}", "description": [], - "signature": [ - "InstallWithTimeoutOpts" - ], + "signature": ["InstallWithTimeoutOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts", "deprecated": false, "trackAdoption": false, @@ -1341,9 +1268,7 @@ "tags": [], "label": "isRuleSnoozed", "description": [], - "signature": [ - "(rule: RuleSnoozeProps) => boolean" - ], + "signature": ["(rule: RuleSnoozeProps) => boolean"], "path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts", "deprecated": false, "trackAdoption": false, @@ -1355,9 +1280,7 @@ "tags": [], "label": "rule", "description": [], - "signature": [ - "RuleSnoozeProps" - ], + "signature": ["RuleSnoozeProps"], "path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts", "deprecated": false, "trackAdoption": false, @@ -1374,9 +1297,7 @@ "tags": [], "label": "isValidAlertIndexName", "description": [], - "signature": [ - "(indexName: string) => boolean" - ], + "signature": ["(indexName: string) => boolean"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/is_valid_alert_index_name.ts", "deprecated": false, "trackAdoption": false, @@ -1388,9 +1309,7 @@ "tags": [], "label": "indexName", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/is_valid_alert_index_name.ts", "deprecated": false, "trackAdoption": false, @@ -1407,9 +1326,7 @@ "tags": [], "label": "parseDuration", "description": [], - "signature": [ - "(duration: string) => number" - ], + "signature": ["(duration: string) => number"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -1421,9 +1338,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -1513,9 +1428,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "ActionGroupIds" - ], + "signature": ["ActionGroupIds"], "path": "packages/kbn-alerting-types/action_group_types.ts", "deprecated": false, "trackAdoption": false @@ -1575,10 +1488,7 @@ "tags": [], "label": "getRulesSettingsClient", "description": [], - "signature": [ - "() => ", - "RulesSettingsClient" - ], + "signature": ["() => ", "RulesSettingsClient"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -1592,10 +1502,7 @@ "tags": [], "label": "getMaintenanceWindowClient", "description": [], - "signature": [ - "() => ", - "MaintenanceWindowClient" - ], + "signature": ["() => ", "MaintenanceWindowClient"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -1609,11 +1516,7 @@ "tags": [], "label": "listTypes", "description": [], - "signature": [ - "() => Set<", - "RegistryRuleType", - ">" - ], + "signature": ["() => Set<", "RegistryRuleType", ">"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -1651,9 +1554,7 @@ "tags": [], "label": "areApiKeysEnabled", "description": [], - "signature": [ - "() => Promise" - ], + "signature": ["() => Promise"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -1746,9 +1647,7 @@ "tags": [], "label": "status", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/server/rules_client/types.ts", "deprecated": false, "trackAdoption": false @@ -1760,9 +1659,7 @@ "tags": [], "label": "rule", "description": [], - "signature": [ - "{ id: string; name: string; }" - ], + "signature": ["{ id: string; name: string; }"], "path": "x-pack/plugins/alerting/server/rules_client/types.ts", "deprecated": false, "trackAdoption": false @@ -1788,9 +1685,7 @@ "tags": [], "label": "isUsingDataStreams", "description": [], - "signature": [ - "() => boolean" - ], + "signature": ["() => boolean"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1804,10 +1699,7 @@ "tags": [], "label": "getIndexTemplateFields", "description": [], - "signature": [ - "(alias: string, pattern: string) => ", - "IndexTemplateFields" - ], + "signature": ["(alias: string, pattern: string) => ", "IndexTemplateFields"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1819,9 +1711,7 @@ "tags": [], "label": "alias", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1834,9 +1724,7 @@ "tags": [], "label": "pattern", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1852,11 +1740,7 @@ "tags": [], "label": "createStream", "description": [], - "signature": [ - "(opts: ", - "CreateConcreteWriteIndexOpts", - ") => Promise" - ], + "signature": ["(opts: ", "CreateConcreteWriteIndexOpts", ") => Promise"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -1868,9 +1752,7 @@ "tags": [], "label": "opts", "description": [], - "signature": [ - "CreateConcreteWriteIndexOpts" - ], + "signature": ["CreateConcreteWriteIndexOpts"], "path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts", "deprecated": false, "trackAdoption": false, @@ -2018,9 +1900,7 @@ "tags": [], "label": "start", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2032,9 +1912,7 @@ "tags": [], "label": "end", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2085,9 +1963,7 @@ "description": [ "\nSpecifies custom mappings for the target alerts-as-data\nindex. These mappings will be translated into a component template\nand used in the index template for the index." ], - "signature": [ - "ComponentTemplateSpec" - ], + "signature": ["ComponentTemplateSpec"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2101,9 +1977,7 @@ "description": [ "\nOptional flag to opt into writing alerts as data. When not specified\ndefaults to false. We need this because we needed all previous rule\nregistry rules to register with the framework in order to install\nElasticsearch assets but we don't want to migrate them to using\nthe framework for writing alerts as data until all the pieces are ready" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2117,9 +1991,7 @@ "description": [ "\nOptional flag to include a reference to the ECS component template." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2133,9 +2005,7 @@ "description": [ "\nOptional flag to include a reference to the legacy alert component template.\nAny rule type that is migrating from the rule registry should set this\nflag to true to ensure their alerts-as-data indices are backwards compatible." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2149,9 +2019,7 @@ "description": [ "\nOptional flag to indicate that resources should be space-aware. When set to\ntrue, alerts-as-data resources will be created for every space where a rule\nof this type runs." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2165,9 +2033,7 @@ "description": [ "\nOptional secondary alias to use. This alias should not include the namespace." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2181,10 +2047,7 @@ "description": [ "\nOptional function to format each alert in summarizedAlerts right after fetching them." ], - "signature": [ - "FormatAlert", - " | undefined" - ], + "signature": ["FormatAlert", " | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -2313,11 +2176,7 @@ "tags": [], "label": "getSecurityHealth", "description": [], - "signature": [ - "() => Promise<", - "SecurityHealth", - ">" - ], + "signature": ["() => Promise<", "SecurityHealth", ">"], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -2354,10 +2213,7 @@ "tags": [], "label": "frameworkAlerts", "description": [], - "signature": [ - "PublicAlertsService", - " & { enabled: () => boolean; }" - ], + "signature": ["PublicAlertsService", " & { enabled: () => boolean; }"], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "trackAdoption": false @@ -2406,11 +2262,7 @@ "tags": [], "label": "listTypes", "description": [], - "signature": [ - "() => Set<", - "RegistryRuleType", - ">" - ], + "signature": ["() => Set<", "RegistryRuleType", ">"], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -2424,9 +2276,7 @@ "tags": [], "label": "getAllTypes", "description": [], - "signature": [ - "() => string[]" - ], + "signature": ["() => string[]"], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -2534,9 +2384,7 @@ "tags": [], "label": "getAlertIndicesAlias", "description": [], - "signature": [ - "(rulesTypes: string[], spaceId?: string | undefined) => string[]" - ], + "signature": ["(rulesTypes: string[], spaceId?: string | undefined) => string[]"], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -2549,9 +2397,7 @@ "tags": [], "label": "rulesTypes", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/server/lib/create_get_alert_indices_alias.ts", "deprecated": false, "trackAdoption": false @@ -2563,9 +2409,7 @@ "tags": [], "label": "spaceId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/lib/create_get_alert_indices_alias.ts", "deprecated": false, "trackAdoption": false @@ -2771,9 +2615,7 @@ "tags": [], "label": "tags", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2807,9 +2649,7 @@ "tags": [], "label": "schedule", "description": [], - "signature": [ - "{ readonly interval: string; }" - ], + "signature": ["{ readonly interval: string; }"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2835,9 +2675,7 @@ "tags": [], "label": "params", "description": [], - "signature": [ - "Params" - ], + "signature": ["Params"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2849,9 +2687,7 @@ "tags": [], "label": "mapped_params", "description": [], - "signature": [ - "Record | undefined" - ], + "signature": ["Record | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2863,9 +2699,7 @@ "tags": [], "label": "scheduledTaskId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2877,9 +2711,7 @@ "tags": [], "label": "createdBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2891,9 +2723,7 @@ "tags": [], "label": "updatedBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2905,9 +2735,7 @@ "tags": [], "label": "createdAt", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2919,9 +2747,7 @@ "tags": [], "label": "updatedAt", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2933,9 +2759,7 @@ "tags": [], "label": "apiKeyOwner", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2947,9 +2771,7 @@ "tags": [], "label": "apiKeyCreatedByUser", "description": [], - "signature": [ - "boolean | null | undefined" - ], + "signature": ["boolean | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -2961,9 +2783,7 @@ "tags": [], "label": "throttle", "description": [], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3000,9 +2820,7 @@ "tags": [], "label": "mutedInstanceIds", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3014,9 +2832,7 @@ "tags": [], "label": "executionStatus", "description": [], - "signature": [ - "RuleExecutionStatus" - ], + "signature": ["RuleExecutionStatus"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3056,9 +2872,7 @@ "tags": [], "label": "activeSnoozes", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3070,9 +2884,7 @@ "tags": [], "label": "isSnoozedUntil", "description": [], - "signature": [ - "Date | null | undefined" - ], + "signature": ["Date | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3098,9 +2910,7 @@ "tags": [], "label": "nextRun", "description": [], - "signature": [ - "Date | null | undefined" - ], + "signature": ["Date | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3123,9 +2933,7 @@ "tags": [], "label": "running", "description": [], - "signature": [ - "boolean | null | undefined" - ], + "signature": ["boolean | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3137,9 +2945,7 @@ "tags": [], "label": "viewInAppRelativeUrl", "description": [], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3151,9 +2957,7 @@ "tags": [], "label": "alertDelay", "description": [], - "signature": [ - "Readonly<{} & { active: number; }> | undefined" - ], + "signature": ["Readonly<{} & { active: number; }> | undefined"], "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false @@ -3220,9 +3024,7 @@ "tags": [], "label": "params", "description": [], - "signature": [ - "Params" - ], + "signature": ["Params"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3234,9 +3036,7 @@ "tags": [], "label": "previousStartedAt", "description": [], - "signature": [ - "Date | null" - ], + "signature": ["Date | null"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3302,9 +3102,7 @@ "tags": [], "label": "startedAt", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3316,9 +3114,7 @@ "tags": [], "label": "state", "description": [], - "signature": [ - "State" - ], + "signature": ["State"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3330,9 +3126,7 @@ "tags": [], "label": "namespace", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3364,9 +3158,7 @@ "tags": [], "label": "maintenanceWindowIds", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3392,9 +3184,7 @@ "tags": [], "label": "timeWindow", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -3511,9 +3301,7 @@ "parentPluginId": "alerting", "id": "def-server.RuleExecutorServices.alertFactory", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "alertFactory", "description": [ "\nDeprecate alertFactory and remove when all rules are onboarded to\nthe alertsClient" @@ -3573,19 +3361,19 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/common.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/common.ts" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/tls_rule.ts" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts" }, { "plugin": "uptime", @@ -3637,9 +3425,7 @@ "tags": [], "label": "shouldWriteAlerts", "description": [], - "signature": [ - "() => boolean" - ], + "signature": ["() => boolean"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -3653,9 +3439,7 @@ "tags": [], "label": "shouldStopExecution", "description": [], - "signature": [ - "() => boolean" - ], + "signature": ["() => boolean"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -3669,10 +3453,7 @@ "tags": [], "label": "ruleMonitoringService", "description": [], - "signature": [ - "PublicMetricsSetters", - " | undefined" - ], + "signature": ["PublicMetricsSetters", " | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -3942,10 +3723,7 @@ "tags": [], "label": "ruleResultService", "description": [], - "signature": [ - "PublicLastRunSetters", - " | undefined" - ], + "signature": ["PublicLastRunSetters", " | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4002,9 +3780,7 @@ "tags": [], "label": "params", "description": [], - "signature": [ - "Params" - ], + "signature": ["Params"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4062,11 +3838,7 @@ "tags": [], "label": "validate", "description": [], - "signature": [ - "{ params: ", - "RuleTypeParamsValidator", - "; }" - ], + "signature": ["{ params: ", "RuleTypeParamsValidator", "; }"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4121,9 +3893,7 @@ "tags": [], "label": "defaultActionGroupId", "description": [], - "signature": [ - "ActionGroupIds" - ], + "signature": ["ActionGroupIds"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4325,9 +4095,7 @@ "tags": [], "label": "defaultScheduleInterval", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4339,9 +4107,7 @@ "tags": [], "label": "ruleTaskTimeout", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4353,9 +4119,7 @@ "tags": [], "label": "cancelAlertsOnRuleTimeout", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4367,9 +4131,7 @@ "tags": [], "label": "doesSetRecoveryContext", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4404,9 +4166,7 @@ "description": [ "\nDetermines whether framework should\nautomatically make recovery determination. Defaults to true." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4418,10 +4178,7 @@ "tags": [], "label": "getViewInAppRelativeUrl", "description": [], - "signature": [ - "GetViewInAppRelativeUrlFn", - " | undefined" - ], + "signature": ["GetViewInAppRelativeUrlFn", " | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4433,9 +4190,7 @@ "tags": [], "label": "fieldsForAAD", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4472,10 +4227,7 @@ "tags": [], "label": "data", "description": [], - "signature": [ - "AlertHit", - "[]" - ], + "signature": ["AlertHit", "[]"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -4600,9 +4352,7 @@ "tags": [], "label": "AlertInstanceContext", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, @@ -4632,9 +4382,7 @@ "description": [ "\nDefault alert index ILM policy\n- _meta.managed: notify users this is a managed policy and should be modified\n at their own risk\n- no delete phase as we want to keep these indices around indefinitely\n\nThis should be used by all alerts-as-data indices" ], - "signature": [ - "\".alerts-ilm-policy\"" - ], + "signature": ["\".alerts-ilm-policy\""], "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, "trackAdoption": false, @@ -4647,9 +4395,7 @@ "tags": [], "label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", "description": [], - "signature": [ - "10" - ], + "signature": ["10"], "path": "x-pack/plugins/alerting/server/config.ts", "deprecated": false, "trackAdoption": false, @@ -4674,9 +4420,7 @@ "tags": [], "label": "ECS_CONTEXT", "description": [], - "signature": [ - "\"ecs\"" - ], + "signature": ["\"ecs\""], "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, @@ -4736,9 +4480,7 @@ "tags": [], "label": "LatestAlertInstanceStateSchema", "description": [], - "signature": [ - "{ [x: string]: any; }" - ], + "signature": ["{ [x: string]: any; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts", "deprecated": false, "trackAdoption": false, @@ -4827,10 +4569,7 @@ "tags": [], "label": "PublicFrameworkAlertsService", "description": [], - "signature": [ - "PublicAlertsService", - " & { enabled: () => boolean; }" - ], + "signature": ["PublicAlertsService", " & { enabled: () => boolean; }"], "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, @@ -4843,9 +4582,7 @@ "tags": [], "label": "RULE_SAVED_OBJECT_TYPE", "description": [], - "signature": [ - "\"alert\"" - ], + "signature": ["\"alert\""], "path": "x-pack/plugins/alerting/server/saved_objects/index.ts", "deprecated": false, "trackAdoption": false, @@ -5146,9 +4883,7 @@ "tags": [], "label": "RuleTypeParams", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -5161,9 +4896,7 @@ "tags": [], "label": "RuleTypeState", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -5176,9 +4909,7 @@ "tags": [], "label": "ScopedQueryAlerts", "description": [], - "signature": [ - "{ [x: string]: string[]; }" - ], + "signature": ["{ [x: string]: string[]; }"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, @@ -5191,9 +4922,7 @@ "tags": [], "label": "TOTAL_FIELDS_LIMIT", "description": [], - "signature": [ - "2500" - ], + "signature": ["2500"], "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, @@ -5206,9 +4935,7 @@ "tags": [], "label": "VALID_ALERT_INDEX_PREFIXES", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/server/alerts_service/resource_installer_utils.ts", "deprecated": false, "trackAdoption": false, @@ -5270,9 +4997,7 @@ "tags": [], "label": "shouldWrite", "description": [], - "signature": [ - "true" - ], + "signature": ["true"], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false @@ -5404,9 +5129,7 @@ "tags": [], "label": "contextToSchemaName", "description": [], - "signature": [ - "(context: string) => string" - ], + "signature": ["(context: string) => string"], "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", "deprecated": false, "trackAdoption": false, @@ -5418,9 +5141,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", "deprecated": false, "trackAdoption": false, @@ -5437,9 +5158,7 @@ "tags": [], "label": "convertDurationToFrequency", "description": [], - "signature": [ - "(duration: string, denomination: number) => number" - ], + "signature": ["(duration: string, denomination: number) => number"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5451,9 +5170,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5466,9 +5183,7 @@ "tags": [], "label": "denomination", "description": [], - "signature": [ - "number" - ], + "signature": ["number"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5485,9 +5200,7 @@ "tags": [], "label": "formatDuration", "description": [], - "signature": [ - "(duration: string, fullUnit: boolean | undefined) => string" - ], + "signature": ["(duration: string, fullUnit: boolean | undefined) => string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5499,9 +5212,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5514,9 +5225,7 @@ "tags": [], "label": "fullUnit", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5668,9 +5377,7 @@ "tags": [], "label": "{\n name,\n fieldMap,\n dynamic,\n includeSettings,\n}", "description": [], - "signature": [ - "GetComponentTemplateFromFieldMapOpts" - ], + "signature": ["GetComponentTemplateFromFieldMapOpts"], "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts", "deprecated": false, "trackAdoption": false, @@ -5687,9 +5394,7 @@ "tags": [], "label": "getDurationNumberInItsUnit", "description": [], - "signature": [ - "(duration: string) => number" - ], + "signature": ["(duration: string) => number"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5701,9 +5406,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5720,9 +5423,7 @@ "tags": [], "label": "getDurationUnitValue", "description": [], - "signature": [ - "(duration: string) => string" - ], + "signature": ["(duration: string) => string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5734,9 +5435,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -5778,9 +5477,7 @@ "tags": [], "label": "name", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts", "deprecated": false, "trackAdoption": false @@ -5828,9 +5525,7 @@ "tags": [], "label": "rules", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts", "deprecated": false, "trackAdoption": false @@ -5864,9 +5559,7 @@ "tags": [], "label": "params", "description": [], - "signature": [ - "GetRuleTagsAggregationParams | undefined" - ], + "signature": ["GetRuleTagsAggregationParams | undefined"], "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false, @@ -5883,9 +5576,7 @@ "tags": [], "label": "getScopedQueryErrorMessage", "description": [], - "signature": [ - "(errorMessage: string) => string" - ], + "signature": ["(errorMessage: string) => string"], "path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -5897,9 +5588,7 @@ "tags": [], "label": "errorMessage", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -5916,9 +5605,7 @@ "tags": [], "label": "isActionGroupDisabledForActionTypeId", "description": [], - "signature": [ - "(actionGroup: string, actionTypeId: string) => boolean" - ], + "signature": ["(actionGroup: string, actionTypeId: string) => boolean"], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "trackAdoption": false, @@ -5930,9 +5617,7 @@ "tags": [], "label": "actionGroup", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "trackAdoption": false, @@ -5945,9 +5630,7 @@ "tags": [], "label": "actionTypeId", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "trackAdoption": false, @@ -5964,9 +5647,7 @@ "tags": [], "label": "isScopedQueryError", "description": [], - "signature": [ - "(errorMessage: string) => boolean" - ], + "signature": ["(errorMessage: string) => boolean"], "path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -5978,9 +5659,7 @@ "tags": [], "label": "errorMessage", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -6041,9 +5720,7 @@ "tags": [], "label": "dynamic", "description": [], - "signature": [ - "boolean | \"strict\"" - ], + "signature": ["boolean | \"strict\""], "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", "deprecated": false, "trackAdoption": false, @@ -6060,9 +5737,7 @@ "tags": [], "label": "parseDuration", "description": [], - "signature": [ - "(duration: string) => number" - ], + "signature": ["(duration: string) => number"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -6074,9 +5749,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -6093,9 +5766,7 @@ "tags": [], "label": "parseRuleCircuitBreakerErrorMessage", "description": [], - "signature": [ - "(message: string) => { summary: string; details?: string | undefined; }" - ], + "signature": ["(message: string) => { summary: string; details?: string | undefined; }"], "path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -6107,9 +5778,7 @@ "tags": [], "label": "message", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts", "deprecated": false, "trackAdoption": false, @@ -6126,9 +5795,7 @@ "tags": [], "label": "validateDurationSchema", "description": [], - "signature": [ - "(duration: string) => string | undefined" - ], + "signature": ["(duration: string) => string | undefined"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -6140,9 +5807,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, @@ -6159,9 +5824,7 @@ "tags": [], "label": "validateNotifyWhenType", "description": [], - "signature": [ - "(notifyWhen: string) => string | undefined" - ], + "signature": ["(notifyWhen: string) => string | undefined"], "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, @@ -6173,9 +5836,7 @@ "tags": [], "label": "notifyWhen", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, @@ -6215,9 +5876,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "ActionGroupIds" - ], + "signature": ["ActionGroupIds"], "path": "packages/kbn-alerting-types/action_group_types.ts", "deprecated": false, "trackAdoption": false @@ -6276,9 +5935,7 @@ "tags": [], "label": "deprecated", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -6290,9 +5947,7 @@ "tags": [], "label": "useWithTripleBracesInTemplates", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -6304,9 +5959,7 @@ "tags": [], "label": "usesPublicBaseUrl", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -6553,9 +6206,7 @@ "tags": [], "label": "hours", "description": [], - "signature": [ - "{ start: string; end: string; }" - ], + "signature": ["{ start: string; end: string; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -6661,9 +6312,7 @@ "tags": [], "label": "uuid", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6675,9 +6324,7 @@ "tags": [], "label": "status", "description": [], - "signature": [ - "\"OK\" | \"Active\"" - ], + "signature": ["\"OK\" | \"Active\""], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6700,9 +6347,7 @@ "tags": [], "label": "actionGroupId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6714,9 +6359,7 @@ "tags": [], "label": "activeStartDate", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6739,9 +6382,7 @@ "tags": [], "label": "maintenanceWindowIds", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6800,9 +6441,7 @@ "tags": [], "label": "tags", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6847,9 +6486,7 @@ "tags": [], "label": "throttle", "description": [], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6894,9 +6531,7 @@ "tags": [], "label": "status", "description": [], - "signature": [ - "\"OK\" | \"Active\" | \"Error\"" - ], + "signature": ["\"OK\" | \"Active\" | \"Error\""], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6908,9 +6543,7 @@ "tags": [], "label": "lastRun", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -6922,9 +6555,7 @@ "tags": [], "label": "errorMessages", "description": [], - "signature": [ - "{ date: string; message: string; }[]" - ], + "signature": ["{ date: string; message: string; }[]"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -7014,9 +6645,7 @@ "tags": [], "label": "name", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false @@ -7028,9 +6657,7 @@ "tags": [], "label": "skip_reason", "description": [], - "signature": [ - "\"RULE_NOT_MODIFIED\"" - ], + "signature": ["\"RULE_NOT_MODIFIED\""], "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false @@ -7103,9 +6730,7 @@ "tags": [], "label": "valuesWithTimestamp", "description": [], - "signature": [ - "{ [x: string]: number; }" - ], + "signature": ["{ [x: string]: number; }"], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false @@ -7433,9 +7058,7 @@ "tags": [], "label": "space_ids", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false @@ -7458,9 +7081,7 @@ "tags": [], "label": "maintenance_window_ids", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false @@ -7652,9 +7273,7 @@ "tags": [], "label": "createdBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false @@ -7666,9 +7285,7 @@ "tags": [], "label": "updatedBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false @@ -7702,9 +7319,7 @@ "parentPluginId": "alerting", "id": "def-common.MaintenanceWindowSOProperties", "type": "Interface", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "MaintenanceWindowSOProperties", "description": [], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", @@ -7814,9 +7429,7 @@ "tags": [], "label": "categoryIds", "description": [], - "signature": [ - "string[] | null | undefined" - ], + "signature": ["string[] | null | undefined"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false @@ -7863,9 +7476,7 @@ "tags": [], "label": "risk_score", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -7877,9 +7488,7 @@ "tags": [], "label": "severity", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -7948,9 +7557,7 @@ "tags": [], "label": "tags", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8025,9 +7632,7 @@ "tags": [], "label": "params", "description": [], - "signature": [ - "Params" - ], + "signature": ["Params"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8060,9 +7665,7 @@ "tags": [], "label": "scheduledTaskId", "description": [], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8074,9 +7677,7 @@ "tags": [], "label": "createdBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8088,9 +7689,7 @@ "tags": [], "label": "updatedBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8102,9 +7701,7 @@ "tags": [], "label": "createdAt", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8116,9 +7713,7 @@ "tags": [], "label": "updatedAt", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8130,9 +7725,7 @@ "tags": [], "label": "apiKey", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8144,9 +7737,7 @@ "tags": [], "label": "apiKeyOwner", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8158,9 +7749,7 @@ "tags": [], "label": "apiKeyCreatedByUser", "description": [], - "signature": [ - "boolean | null | undefined" - ], + "signature": ["boolean | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8172,9 +7761,7 @@ "tags": [], "label": "throttle", "description": [], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8211,9 +7798,7 @@ "tags": [], "label": "mutedInstanceIds", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8287,9 +7872,7 @@ "tags": [], "label": "activeSnoozes", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8301,9 +7884,7 @@ "tags": [], "label": "isSnoozedUntil", "description": [], - "signature": [ - "Date | null | undefined" - ], + "signature": ["Date | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8336,9 +7917,7 @@ "tags": [], "label": "nextRun", "description": [], - "signature": [ - "Date | null | undefined" - ], + "signature": ["Date | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8361,9 +7940,7 @@ "tags": [], "label": "running", "description": [], - "signature": [ - "boolean | null | undefined" - ], + "signature": ["boolean | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8375,9 +7952,7 @@ "tags": [], "label": "viewInAppRelativeUrl", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8424,9 +7999,7 @@ "tags": [], "label": "uuid", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8533,9 +8106,7 @@ "tags": [], "label": "useAlertDataForTemplate", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8589,9 +8160,7 @@ "tags": [], "label": "notifyWhen", "description": [], - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" - ], + "signature": ["\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8603,9 +8172,7 @@ "tags": [], "label": "throttle", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8645,9 +8212,7 @@ "tags": [], "label": "lastExecutionDate", "description": [], - "signature": [ - "Date" - ], + "signature": ["Date"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8659,9 +8224,7 @@ "tags": [], "label": "lastDuration", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8731,9 +8294,7 @@ "tags": [], "label": "outcome", "description": [], - "signature": [ - "\"warning\" | \"succeeded\" | \"failed\"" - ], + "signature": ["\"warning\" | \"succeeded\" | \"failed\""], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8745,9 +8306,7 @@ "tags": [], "label": "outcomeOrder", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8788,9 +8347,7 @@ "tags": [], "label": "outcomeMsg", "description": [], - "signature": [ - "string[] | null | undefined" - ], + "signature": ["string[] | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8899,9 +8456,7 @@ "tags": [], "label": "p50", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8913,9 +8468,7 @@ "tags": [], "label": "p95", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -8927,9 +8480,7 @@ "tags": [], "label": "p99", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9005,9 +8556,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9019,9 +8568,7 @@ "tags": [], "label": "outcome", "description": [], - "signature": [ - "\"warning\" | \"succeeded\" | \"failed\" | undefined" - ], + "signature": ["\"warning\" | \"succeeded\" | \"failed\" | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9126,9 +8673,7 @@ "tags": [], "label": "duration", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9140,9 +8685,7 @@ "tags": [], "label": "total_search_duration_ms", "description": [], - "signature": [ - "number | null | undefined" - ], + "signature": ["number | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9154,9 +8697,7 @@ "tags": [], "label": "total_indexing_duration_ms", "description": [], - "signature": [ - "number | null | undefined" - ], + "signature": ["number | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9168,9 +8709,7 @@ "tags": [], "label": "total_alerts_detected", "description": [], - "signature": [ - "number | null | undefined" - ], + "signature": ["number | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9182,9 +8721,7 @@ "tags": [], "label": "total_alerts_created", "description": [], - "signature": [ - "number | null | undefined" - ], + "signature": ["number | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9196,9 +8733,7 @@ "tags": [], "label": "gap_duration_s", "description": [], - "signature": [ - "number | null | undefined" - ], + "signature": ["number | null | undefined"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false @@ -9265,9 +8800,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "deprecated": false, "trackAdoption": false @@ -9279,9 +8812,7 @@ "tags": [], "label": "skipRecurrences", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "deprecated": false, "trackAdoption": false @@ -9410,9 +8941,7 @@ "tags": [], "label": "createdBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false @@ -9424,9 +8953,7 @@ "tags": [], "label": "updatedBy", "description": [], - "signature": [ - "string | null" - ], + "signature": ["string | null"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false @@ -9555,9 +9082,7 @@ "tags": [], "label": "ruleTags", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false @@ -9583,9 +9108,7 @@ "tags": [], "label": "tags", "description": [], - "signature": [ - "{ buckets: { key: { tags: string; }; doc_count: number; }[]; }" - ], + "signature": ["{ buckets: { key: { tags: string; }; doc_count: number; }[]; }"], "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false @@ -9723,9 +9246,7 @@ "tags": [], "label": "defaultActionGroupId", "description": [], - "signature": [ - "ActionGroupIds" - ], + "signature": ["ActionGroupIds"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -9784,9 +9305,7 @@ "tags": [], "label": "ruleTaskTimeout", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -9798,9 +9317,7 @@ "tags": [], "label": "defaultScheduleInterval", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -9812,9 +9329,7 @@ "tags": [], "label": "doesSetRecoveryContext", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -9837,9 +9352,7 @@ "tags": [], "label": "authorizedConsumers", "description": [], - "signature": [ - "{ [x: string]: ConsumerPrivileges; }" - ], + "signature": ["{ [x: string]: ConsumerPrivileges; }"], "path": "packages/kbn-alerting-types/rule_type.ts", "deprecated": false, "trackAdoption": false @@ -9950,10 +9463,7 @@ "tags": [], "label": "filters", "description": [], - "signature": [ - "ScopeQueryFilter", - "[]" - ], + "signature": ["ScopeQueryFilter", "[]"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false @@ -9965,9 +9475,7 @@ "tags": [], "label": "dsl", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false @@ -10046,9 +9554,7 @@ "tags": [], "label": "actionErrorLogSortableColumns", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, @@ -10061,9 +9567,7 @@ "tags": [], "label": "ActionErrorLogSortFields", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, @@ -10107,9 +9611,7 @@ "tags": [], "label": "AlertInstanceContext", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, @@ -10122,9 +9624,7 @@ "tags": [], "label": "ALERTS_FEATURE_ID", "description": [], - "signature": [ - "\"alerts\"" - ], + "signature": ["\"alerts\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10137,9 +9637,7 @@ "tags": [], "label": "AlertStatusValues", "description": [], - "signature": [ - "\"OK\" | \"Active\"" - ], + "signature": ["\"OK\" | \"Active\""], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false, @@ -10152,9 +9650,7 @@ "tags": [], "label": "ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID", "description": [], - "signature": [ - "\"allFlappingSettings\"" - ], + "signature": ["\"allFlappingSettings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10167,9 +9663,7 @@ "tags": [], "label": "ALL_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID", "description": [], - "signature": [ - "\"allQueryDelaySettings\"" - ], + "signature": ["\"allQueryDelaySettings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10182,9 +9676,7 @@ "tags": [], "label": "BASE_ALERTING_API_PATH", "description": [], - "signature": [ - "\"/api/alerting\"" - ], + "signature": ["\"/api/alerting\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10197,9 +9689,7 @@ "tags": [], "label": "BulkEditSkipReason", "description": [], - "signature": [ - "\"RULE_NOT_MODIFIED\"" - ], + "signature": ["\"RULE_NOT_MODIFIED\""], "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false, @@ -10212,9 +9702,7 @@ "tags": [], "label": "DEFAULT_LOOK_BACK_WINDOW", "description": [], - "signature": [ - "20" - ], + "signature": ["20"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10227,9 +9715,7 @@ "tags": [], "label": "DEFAULT_QUERY_DELAY", "description": [], - "signature": [ - "0" - ], + "signature": ["0"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10242,9 +9728,7 @@ "tags": [], "label": "DEFAULT_SERVERLESS_QUERY_DELAY", "description": [], - "signature": [ - "15" - ], + "signature": ["15"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10257,9 +9741,7 @@ "tags": [], "label": "DEFAULT_STATUS_CHANGE_THRESHOLD", "description": [], - "signature": [ - "4" - ], + "signature": ["4"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10272,9 +9754,7 @@ "tags": [], "label": "DefaultActionGroupId", "description": [], - "signature": [ - "\"default\"" - ], + "signature": ["\"default\""], "path": "packages/kbn-alerting-types/builtin_action_groups_types.ts", "deprecated": false, "trackAdoption": false, @@ -10287,9 +9767,7 @@ "tags": [], "label": "ENABLE_MAINTENANCE_WINDOWS", "description": [], - "signature": [ - "true" - ], + "signature": ["true"], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10332,9 +9810,7 @@ "tags": [], "label": "INTERNAL_ALERTING_API_FIND_RULES_PATH", "description": [], - "signature": [ - "\"/internal/alerting/rules/_find\"" - ], + "signature": ["\"/internal/alerting/rules/_find\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10347,9 +9823,7 @@ "tags": [], "label": "INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH", "description": [], - "signature": [ - "\"/internal/alerting/rules/maintenance_window/_active\"" - ], + "signature": ["\"/internal/alerting/rules/maintenance_window/_active\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10362,9 +9836,7 @@ "tags": [], "label": "INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH", "description": [], - "signature": [ - "\"/internal/alerting/rules/maintenance_window\"" - ], + "signature": ["\"/internal/alerting/rules/maintenance_window\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10377,9 +9849,7 @@ "tags": [], "label": "INTERNAL_ALERTING_SNOOZE_RULE", "description": [], - "signature": [ - "\"/internal/alerting/rule/{id}/_snooze\"" - ], + "signature": ["\"/internal/alerting/rule/{id}/_snooze\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10392,9 +9862,7 @@ "tags": [], "label": "INTERNAL_BASE_ALERTING_API_PATH", "description": [], - "signature": [ - "\"/internal/alerting\"" - ], + "signature": ["\"/internal/alerting\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10429,9 +9897,7 @@ "tags": [], "label": "IsoWeekday", "description": [], - "signature": [ - "2 | 7 | 6 | 5 | 4 | 3 | 1" - ], + "signature": ["2 | 7 | 6 | 5 | 4 | 3 | 1"], "path": "x-pack/plugins/alerting/common/iso_weekdays.ts", "deprecated": false, "trackAdoption": false, @@ -10459,9 +9925,7 @@ "tags": [], "label": "LatestAlertInstanceStateSchema", "description": [], - "signature": [ - "{ [x: string]: any; }" - ], + "signature": ["{ [x: string]: any; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts", "deprecated": false, "trackAdoption": false, @@ -10519,9 +9983,7 @@ "tags": [], "label": "LatestThrottledActionSchema", "description": [], - "signature": [ - "{ [x: string]: Readonly<{} & { date: string; }>; }" - ], + "signature": ["{ [x: string]: Readonly<{} & { date: string; }>; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts", "deprecated": false, "trackAdoption": false, @@ -10534,9 +9996,7 @@ "tags": [], "label": "LEGACY_BASE_ALERT_API_PATH", "description": [], - "signature": [ - "\"/api/alerts\"" - ], + "signature": ["\"/api/alerts\""], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10549,9 +10009,7 @@ "tags": [], "label": "MAINTENANCE_WINDOW_DATE_FORMAT", "description": [], - "signature": [ - "\"MM/DD/YY hh:mm A\"" - ], + "signature": ["\"MM/DD/YY hh:mm A\""], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10564,9 +10022,7 @@ "tags": [], "label": "MAINTENANCE_WINDOW_FEATURE_ID", "description": [], - "signature": [ - "\"maintenanceWindow\"" - ], + "signature": ["\"maintenanceWindow\""], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10579,9 +10035,7 @@ "tags": [], "label": "MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE", "description": [], - "signature": [ - "\"maintenance-window\"" - ], + "signature": ["\"maintenance-window\""], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10594,9 +10048,7 @@ "tags": [], "label": "MAINTENANCE_WINDOWS_APP_ID", "description": [], - "signature": [ - "\"maintenanceWindows\"" - ], + "signature": ["\"maintenanceWindows\""], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10606,9 +10058,7 @@ "parentPluginId": "alerting", "id": "def-common.MaintenanceWindow", "type": "Type", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "MaintenanceWindow", "description": [], "signature": [ @@ -10766,9 +10216,7 @@ "tags": [], "label": "MaintenanceWindowDeepLinkIds", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10778,9 +10226,7 @@ "parentPluginId": "alerting", "id": "def-common.MaintenanceWindowSOAttributes", "type": "Type", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "MaintenanceWindowSOAttributes", "description": [], "signature": [ @@ -10813,9 +10259,7 @@ "tags": [], "label": "MANAGEMENT_APP_ID", "description": [], - "signature": [ - "\"management\"" - ], + "signature": ["\"management\""], "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, @@ -10857,9 +10301,7 @@ "tags": [], "label": "MAX_LOOK_BACK_WINDOW", "description": [], - "signature": [ - "20" - ], + "signature": ["20"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10872,9 +10314,7 @@ "tags": [], "label": "MAX_QUERY_DELAY", "description": [], - "signature": [ - "60" - ], + "signature": ["60"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10887,9 +10327,7 @@ "tags": [], "label": "MAX_STATUS_CHANGE_THRESHOLD", "description": [], - "signature": [ - "20" - ], + "signature": ["20"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10902,9 +10340,7 @@ "tags": [], "label": "MIN_LOOK_BACK_WINDOW", "description": [], - "signature": [ - "2" - ], + "signature": ["2"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10917,9 +10353,7 @@ "tags": [], "label": "MIN_QUERY_DELAY", "description": [], - "signature": [ - "0" - ], + "signature": ["0"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10932,9 +10366,7 @@ "tags": [], "label": "MIN_STATUS_CHANGE_THRESHOLD", "description": [], - "signature": [ - "2" - ], + "signature": ["2"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10947,9 +10379,7 @@ "tags": [], "label": "MONITORING_HISTORY_LIMIT", "description": [], - "signature": [ - "200" - ], + "signature": ["200"], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -10962,9 +10392,7 @@ "tags": [], "label": "preconfiguredConnectorActionRefPrefix", "description": [], - "signature": [ - "\"preconfigured:\"" - ], + "signature": ["\"preconfigured:\""], "path": "x-pack/plugins/alerting/common/action_ref_prefix.ts", "deprecated": false, "trackAdoption": false, @@ -10977,9 +10405,7 @@ "tags": [], "label": "READ_FLAPPING_SETTINGS_SUB_FEATURE_ID", "description": [], - "signature": [ - "\"readFlappingSettings\"" - ], + "signature": ["\"readFlappingSettings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -10992,9 +10418,7 @@ "tags": [], "label": "READ_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID", "description": [], - "signature": [ - "\"readQueryDelaySettings\"" - ], + "signature": ["\"readQueryDelaySettings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -11007,9 +10431,7 @@ "tags": [], "label": "RecoveredActionGroupId", "description": [], - "signature": [ - "\"recovered\"" - ], + "signature": ["\"recovered\""], "path": "packages/kbn-alerting-types/builtin_action_groups_types.ts", "deprecated": false, "trackAdoption": false, @@ -11022,9 +10444,7 @@ "tags": [], "label": "ReservedActionGroups", "description": [], - "signature": [ - "RecoveryActionGroupId | \"recovered\"" - ], + "signature": ["RecoveryActionGroupId | \"recovered\""], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "trackAdoption": false, @@ -11212,9 +10632,7 @@ "tags": [], "label": "RuleAlertData", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11227,9 +10645,7 @@ "tags": [], "label": "RuleAlertingOutcome", "description": [], - "signature": [ - "\"warning\" | \"unknown\" | \"success\" | \"failure\"" - ], + "signature": ["\"warning\" | \"unknown\" | \"success\" | \"failure\""], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11242,9 +10658,7 @@ "tags": [], "label": "RuleExecutionStatuses", "description": [], - "signature": [ - "\"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\" | \"unknown\"" - ], + "signature": ["\"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\" | \"unknown\""], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11257,9 +10671,7 @@ "tags": [], "label": "RuleLastRunOutcomes", "description": [], - "signature": [ - "\"warning\" | \"succeeded\" | \"failed\"" - ], + "signature": ["\"warning\" | \"succeeded\" | \"failed\""], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11272,9 +10684,7 @@ "tags": [], "label": "RuleNotifyWhenType", "description": [], - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" - ], + "signature": ["\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""], "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, @@ -11287,9 +10697,7 @@ "tags": [], "label": "RULES_SETTINGS_FEATURE_ID", "description": [], - "signature": [ - "\"rulesSettings\"" - ], + "signature": ["\"rulesSettings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -11302,9 +10710,7 @@ "tags": [], "label": "RULES_SETTINGS_FLAPPING_SAVED_OBJECT_ID", "description": [], - "signature": [ - "\"rules-settings\"" - ], + "signature": ["\"rules-settings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -11317,9 +10723,7 @@ "tags": [], "label": "RULES_SETTINGS_QUERY_DELAY_SAVED_OBJECT_ID", "description": [], - "signature": [ - "\"query-delay-settings\"" - ], + "signature": ["\"query-delay-settings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -11332,9 +10736,7 @@ "tags": [], "label": "RULES_SETTINGS_SAVED_OBJECT_TYPE", "description": [], - "signature": [ - "\"rules-settings\"" - ], + "signature": ["\"rules-settings\""], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, @@ -11428,9 +10830,7 @@ "tags": [], "label": "RuleStatusValues", "description": [], - "signature": [ - "\"OK\" | \"Active\" | \"Error\"" - ], + "signature": ["\"OK\" | \"Active\" | \"Error\""], "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false, @@ -11462,9 +10862,7 @@ "tags": [], "label": "RuleTaskParams", "description": [], - "signature": [ - "{ alertId: string; } & { spaceId?: string | undefined; }" - ], + "signature": ["{ alertId: string; } & { spaceId?: string | undefined; }"], "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", "deprecated": false, "trackAdoption": false, @@ -11477,9 +10875,7 @@ "tags": [], "label": "RuleTypeMetaData", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11492,9 +10888,7 @@ "tags": [], "label": "RuleTypeParams", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11507,9 +10901,7 @@ "tags": [], "label": "RuleTypeState", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], + "signature": ["{ [x: string]: unknown; }"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -11607,9 +10999,7 @@ "tags": [], "label": "systemConnectorActionRefPrefix", "description": [], - "signature": [ - "\"system_action:\"" - ], + "signature": ["\"system_action:\""], "path": "x-pack/plugins/alerting/common/action_ref_prefix.ts", "deprecated": false, "trackAdoption": false, @@ -11690,9 +11080,7 @@ "tags": [], "label": "dynamic", "description": [], - "signature": [ - "false" - ], + "signature": ["false"], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11726,9 +11114,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"boolean\"" - ], + "signature": ["\"boolean\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11753,9 +11139,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"text\"" - ], + "signature": ["\"text\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11789,9 +11173,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11831,9 +11213,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11858,9 +11238,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11907,9 +11285,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11938,9 +11314,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11965,9 +11339,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -11992,9 +11364,7 @@ "tags": [], "label": "dynamic", "description": [], - "signature": [ - "false" - ], + "signature": ["false"], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12006,9 +11376,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"nested\"" - ], + "signature": ["\"nested\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12042,9 +11410,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12069,9 +11435,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12096,9 +11460,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12127,9 +11489,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"flattened\"" - ], + "signature": ["\"flattened\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12187,9 +11547,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12214,9 +11572,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12245,9 +11601,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12272,9 +11626,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12299,9 +11651,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12326,9 +11676,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"date\"" - ], + "signature": ["\"date\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12353,9 +11701,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"date\"" - ], + "signature": ["\"date\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12382,9 +11728,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12409,9 +11753,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12436,9 +11778,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"boolean\"" - ], + "signature": ["\"boolean\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12463,9 +11803,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12560,9 +11898,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12587,9 +11923,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12614,9 +11948,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12641,9 +11973,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12694,9 +12024,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"date\"" - ], + "signature": ["\"date\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12743,9 +12071,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12770,9 +12096,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12797,9 +12121,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12824,9 +12146,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12851,9 +12171,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12878,9 +12196,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12909,9 +12225,7 @@ "type": "Object", "tags": [], "label": "revision", - "description": [ - "// There is need to query for a rule by a specific revision" - ], + "description": ["// There is need to query for a rule by a specific revision"], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false, @@ -12923,9 +12237,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12950,9 +12262,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"nested\"" - ], + "signature": ["\"nested\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -12986,9 +12296,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13013,9 +12321,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13040,9 +12346,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"date\"" - ], + "signature": ["\"date\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13106,9 +12410,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13133,9 +12435,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13160,9 +12460,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"date\"" - ], + "signature": ["\"date\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13187,9 +12485,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"long\"" - ], + "signature": ["\"long\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13236,9 +12532,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13263,9 +12557,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13316,9 +12608,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13343,9 +12633,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13400,9 +12688,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"keyword\"" - ], + "signature": ["\"keyword\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13427,9 +12713,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13478,9 +12762,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13505,9 +12787,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13532,9 +12812,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13559,9 +12837,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"float\"" - ], + "signature": ["\"float\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13594,9 +12870,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"boolean\"" - ], + "signature": ["\"boolean\""], "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", "deprecated": false, "trackAdoption": false @@ -13684,9 +12958,7 @@ "tags": [], "label": "enabled", "description": [], - "signature": [ - "true" - ], + "signature": ["true"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false @@ -13784,9 +13056,7 @@ "tags": [], "label": "Unnamed", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false @@ -13798,9 +13068,7 @@ "tags": [], "label": "enabled", "description": [], - "signature": [ - "false" - ], + "signature": ["false"], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false @@ -13815,9 +13083,7 @@ "tags": [], "label": "DisabledActionTypeIdsForActionGroup", "description": [], - "signature": [ - "Map" - ], + "signature": ["Map"], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "trackAdoption": false, @@ -14101,9 +13367,7 @@ "tags": [], "label": "RecoveredActionGroup", "description": [], - "signature": [ - "{ readonly id: \"recovered\"; readonly name: string; }" - ], + "signature": ["{ readonly id: \"recovered\"; readonly name: string; }"], "path": "packages/kbn-alerting-types/builtin_action_groups_types.ts", "deprecated": false, "trackAdoption": false, @@ -14178,9 +13442,7 @@ "tags": [], "label": "RuleLastRunOutcomeValues", "description": [], - "signature": [ - "readonly [\"succeeded\", \"warning\", \"failed\"]" - ], + "signature": ["readonly [\"succeeded\", \"warning\", \"failed\"]"], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, @@ -14203,4 +13465,4 @@ } ] } -} \ No newline at end of file +} diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index d75fdd303201..aafd4d57de65 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -1515,11 +1515,11 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/common.ts#:~:text=alertFactory), [message_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts#:~:text=alertFactory), [tls_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts#:~:text=alertFactory), [monitor_status_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts#:~:text=alertFactory) | - | -| | [stderr_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx#:~:text=indexPatternId) | - | -| | [toast_title.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx#:~:text=toMountPoint), [toast_title.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx#:~:text=toMountPoint), [browser_test_results.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx#:~:text=toMountPoint), [browser_test_results.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint)+ 6 more | - | -| | [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider) | - | -| | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/saved_objects/synthetics_monitor.ts#:~:text=migrations) | - | +| | [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/common.ts#:~:text=alertFactory), [message_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts#:~:text=alertFactory), [tls_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/tls_rule.ts#:~:text=alertFactory), [monitor_status_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts#:~:text=alertFactory) | - | +| | [stderr_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx#:~:text=indexPatternId) | - | +| | [toast_title.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx#:~:text=toMountPoint), [toast_title.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx#:~:text=toMountPoint), [browser_test_results.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx#:~:text=toMountPoint), [browser_test_results.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_monitor.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint), [delete_param.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx#:~:text=toMountPoint)+ 6 more | - | +| | [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=KibanaThemeProvider) | - | +| | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/saved_objects/synthetics_monitor.ts#:~:text=migrations) | - | @@ -1725,4 +1725,4 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [shared_imports.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/shared_imports.ts#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 | \ No newline at end of file +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 | diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index cd154884872a..65f0a203ea03 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -60,9 +60,7 @@ "tags": [], "label": "props", "description": [], - "signature": [ - "P" - ], + "signature": ["P"], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false @@ -101,10 +99,7 @@ "tags": [], "label": "result", "description": [], - "signature": [ - "DataTableRecord", - "[] | undefined" - ], + "signature": ["DataTableRecord", "[] | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts", "deprecated": false, "trackAdoption": false @@ -137,9 +132,7 @@ "tags": [], "label": "textBasedHeaderWarning", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts", "deprecated": false, "trackAdoption": false @@ -151,10 +144,7 @@ "tags": [], "label": "interceptedWarnings", "description": [], - "signature": [ - "SearchResponseIncompleteWarning", - "[] | undefined" - ], + "signature": ["SearchResponseIncompleteWarning", "[] | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts", "deprecated": false, "trackAdoption": false @@ -179,12 +169,8 @@ "type": "Array", "tags": [], "label": "columns", - "description": [ - "\nColumns displayed in the table" - ], - "signature": [ - "string[] | undefined" - ], + "description": ["\nColumns displayed in the table"], + "signature": ["string[] | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -195,9 +181,7 @@ "type": "Array", "tags": [], "label": "filters", - "description": [ - "\nArray of applied filters" - ], + "description": ["\nArray of applied filters"], "signature": [ { "pluginId": "@kbn/es-query", @@ -218,9 +202,7 @@ "type": "Object", "tags": [], "label": "grid", - "description": [ - "\nData Grid related state" - ], + "description": ["\nData Grid related state"], "signature": [ { "pluginId": "savedSearch", @@ -241,12 +223,8 @@ "type": "CompoundType", "tags": [], "label": "hideChart", - "description": [ - "\nHide chart" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["\nHide chart"], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -257,12 +235,8 @@ "type": "string", "tags": [], "label": "index", - "description": [ - "\nid of the used data view" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nid of the used data view"], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -273,12 +247,8 @@ "type": "string", "tags": [], "label": "interval", - "description": [ - "\nUsed interval of the histogram" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nUsed interval of the histogram"], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -289,9 +259,7 @@ "type": "CompoundType", "tags": [], "label": "query", - "description": [ - "\nLucence or KQL query" - ], + "description": ["\nLucence or KQL query"], "signature": [ { "pluginId": "@kbn/es-query", @@ -320,12 +288,8 @@ "type": "Array", "tags": [], "label": "sort", - "description": [ - "\nArray of the used sorting [[field,direction],...]" - ], - "signature": [ - "string[][] | undefined" - ], + "description": ["\nArray of the used sorting [[field,direction],...]"], + "signature": ["string[][] | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -336,12 +300,8 @@ "type": "string", "tags": [], "label": "savedQuery", - "description": [ - "\nid of the used saved query" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nid of the used saved query"], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -352,9 +312,7 @@ "type": "CompoundType", "tags": [], "label": "viewMode", - "description": [ - "\nTable view: Documents vs Field Statistics" - ], + "description": ["\nTable view: Documents vs Field Statistics"], "signature": [ { "pluginId": "savedSearch", @@ -378,9 +336,7 @@ "description": [ "\nHide mini distribution/preview charts when in Field Statistics mode" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -391,12 +347,8 @@ "type": "number", "tags": [], "label": "rowHeight", - "description": [ - "\nDocument explorer row height option" - ], - "signature": [ - "number | undefined" - ], + "description": ["\nDocument explorer row height option"], + "signature": ["number | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -407,12 +359,8 @@ "type": "number", "tags": [], "label": "headerRowHeight", - "description": [ - "\nDocument explorer header row height option" - ], - "signature": [ - "number | undefined" - ], + "description": ["\nDocument explorer header row height option"], + "signature": ["number | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -423,12 +371,8 @@ "type": "number", "tags": [], "label": "rowsPerPage", - "description": [ - "\nNumber of rows in the grid per page" - ], - "signature": [ - "number | undefined" - ], + "description": ["\nNumber of rows in the grid per page"], + "signature": ["number | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -439,12 +383,8 @@ "type": "number", "tags": [], "label": "sampleSize", - "description": [ - "\nCustom sample size" - ], - "signature": [ - "number | undefined" - ], + "description": ["\nCustom sample size"], + "signature": ["number | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -455,12 +395,8 @@ "type": "string", "tags": [], "label": "breakdownField", - "description": [ - "\nBreakdown field of chart" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nBreakdown field of chart"], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false @@ -582,9 +518,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "TCustomizationId" - ], + "signature": ["TCustomizationId"], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, @@ -695,9 +629,7 @@ "tags": [], "label": "options", "description": [], - "signature": [ - "CustomizationCallbackContext" - ], + "signature": ["CustomizationCallbackContext"], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false @@ -745,12 +677,8 @@ "type": "Object", "tags": [], "label": "globalState", - "description": [ - "\nGlobal State, the _g part of the URL" - ], - "signature": [ - "DiscoverGlobalStateContainer" - ], + "description": ["\nGlobal State, the _g part of the URL"], + "signature": ["DiscoverGlobalStateContainer"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -761,12 +689,8 @@ "type": "Object", "tags": [], "label": "appState", - "description": [ - "\nApp state, the _a part of the URL" - ], - "signature": [ - "DiscoverAppStateContainer" - ], + "description": ["\nApp state, the _a part of the URL"], + "signature": ["DiscoverAppStateContainer"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -777,12 +701,8 @@ "type": "Object", "tags": [], "label": "dataState", - "description": [ - "\nData fetching related state" - ], - "signature": [ - "DiscoverDataStateContainer" - ], + "description": ["\nData fetching related state"], + "signature": ["DiscoverDataStateContainer"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -793,9 +713,7 @@ "type": "Object", "tags": [], "label": "internalState", - "description": [ - "\nInternal shared state that's used at several places in the UI" - ], + "description": ["\nInternal shared state that's used at several places in the UI"], "signature": [ { "pluginId": "kibanaUtils", @@ -818,12 +736,8 @@ "type": "Object", "tags": [], "label": "savedSearchState", - "description": [ - "\nState of saved search, the saved object of Discover" - ], - "signature": [ - "DiscoverSavedSearchContainer" - ], + "description": ["\nState of saved search, the saved object of Discover"], + "signature": ["DiscoverSavedSearchContainer"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -834,9 +748,7 @@ "type": "Object", "tags": [], "label": "stateStorage", - "description": [ - "\nState of url, allows updating and subscribing to url changes" - ], + "description": ["\nState of url, allows updating and subscribing to url changes"], "signature": [ { "pluginId": "kibanaUtils", @@ -856,12 +768,8 @@ "type": "Object", "tags": [], "label": "searchSessionManager", - "description": [ - "\nService for handling search sessions" - ], - "signature": [ - "DiscoverSearchSessionManager" - ], + "description": ["\nService for handling search sessions"], + "signature": ["DiscoverSearchSessionManager"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -872,12 +780,8 @@ "type": "Object", "tags": [], "label": "customizationContext", - "description": [ - "\nContext object for customization related properties" - ], - "signature": [ - "DiscoverCustomizationContext" - ], + "description": ["\nContext object for customization related properties"], + "signature": ["DiscoverCustomizationContext"], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false @@ -888,9 +792,7 @@ "type": "Object", "tags": [], "label": "actions", - "description": [ - "\nComplex functions to update multiple containers from UI" - ], + "description": ["\nComplex functions to update multiple containers from UI"], "signature": [ "{ fetchData: (initial?: boolean | undefined) => void; initializeAndSync: () => () => void; loadDataViewList: () => Promise; loadSavedSearch: (param?: ", "LoadParams", @@ -1033,9 +935,7 @@ "tags": [], "label": "doc", "description": [], - "signature": [ - "DataTableRecord" - ], + "signature": ["DataTableRecord"], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false @@ -1047,9 +947,7 @@ "tags": [], "label": "renderDefaultContent", "description": [], - "signature": [ - "() => React.ReactNode" - ], + "signature": ["() => React.ReactNode"], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false, @@ -1077,9 +975,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "\"flyout\"" - ], + "signature": ["\"flyout\""], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false @@ -1091,10 +987,7 @@ "tags": [], "label": "size", "description": [], - "signature": [ - "Property", - ".Width | undefined" - ], + "signature": ["Property", ".Width | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false @@ -1106,9 +999,7 @@ "tags": [], "label": "title", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false @@ -1263,9 +1154,7 @@ "tags": [], "label": "hasTimeRange", "description": [], - "signature": [ - "() => boolean" - ], + "signature": ["() => boolean"], "path": "src/plugins/discover/public/embeddable/types.ts", "deprecated": false, "trackAdoption": false, @@ -1315,9 +1204,7 @@ "tags": [], "label": "selectedTab", "description": [], - "signature": [ - "\"discover\" | \"logs-explorer\"" - ], + "signature": ["\"discover\" | \"logs-explorer\""], "path": "src/plugins/discover/public/components/logs_explorer_tabs/logs_explorer_tabs.tsx", "deprecated": false, "trackAdoption": false @@ -1343,9 +1230,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "\"search_bar\"" - ], + "signature": ["\"search_bar\""], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false @@ -1357,9 +1242,7 @@ "tags": [], "label": "CustomDataViewPicker", "description": [], - "signature": [ - "React.ComponentType<{}> | undefined" - ], + "signature": ["React.ComponentType<{}> | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false @@ -1371,9 +1254,7 @@ "tags": [], "label": "PrependFilterBar", "description": [], - "signature": [ - "React.ComponentType<{}> | undefined" - ], + "signature": ["React.ComponentType<{}> | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false @@ -1415,9 +1296,7 @@ "tags": [], "label": "hideDataViewPicker", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false @@ -1443,9 +1322,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "\"top_nav\"" - ], + "signature": ["\"top_nav\""], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false @@ -1457,10 +1334,7 @@ "tags": [], "label": "defaultMenu", "description": [], - "signature": [ - "TopNavDefaultMenu", - " | undefined" - ], + "signature": ["TopNavDefaultMenu", " | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false @@ -1472,11 +1346,7 @@ "tags": [], "label": "getMenuItems", "description": [], - "signature": [ - "(() => ", - "TopNavMenuItem", - "[]) | undefined" - ], + "signature": ["(() => ", "TopNavMenuItem", "[]) | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false, @@ -1490,10 +1360,7 @@ "tags": [], "label": "defaultBadges", "description": [], - "signature": [ - "TopNavDefaultBadges", - " | undefined" - ], + "signature": ["TopNavDefaultBadges", " | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false @@ -1505,11 +1372,7 @@ "tags": [], "label": "getBadges", "description": [], - "signature": [ - "(() => ", - "TopNavBadge", - "[]) | undefined" - ], + "signature": ["(() => ", "TopNavBadge", "[]) | undefined"], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false, @@ -1546,9 +1409,7 @@ "tags": [], "label": "options", "description": [], - "signature": [ - "CustomizationCallbackContext" - ], + "signature": ["CustomizationCallbackContext"], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false @@ -1651,9 +1512,7 @@ "tags": [], "label": "DiscoverProfileId", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, @@ -1723,9 +1582,7 @@ "tags": [], "label": "SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID", "description": [], - "signature": [ - "\"SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID\"" - ], + "signature": ["\"SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID\""], "path": "src/plugins/discover/public/embeddable/constants.ts", "deprecated": false, "trackAdoption": false, @@ -1738,9 +1595,7 @@ "tags": [], "label": "SEARCH_EMBEDDABLE_TYPE", "description": [], - "signature": [ - "\"search\"" - ], + "signature": ["\"search\""], "path": "packages/kbn-discover-utils/src/constants.ts", "deprecated": false, "trackAdoption": false, @@ -1841,9 +1696,7 @@ "tags": [], "label": "showLogsExplorerTabs", "description": [], - "signature": [ - "() => void" - ], + "signature": ["() => void"], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "trackAdoption": false, @@ -2443,9 +2296,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "\"DISCOVER_APP_LOCATOR\"" - ], + "signature": ["\"DISCOVER_APP_LOCATOR\""], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2457,9 +2308,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false, @@ -2471,9 +2320,7 @@ "tags": [], "label": "deps", "description": [], - "signature": [ - "DiscoverAppLocatorDependencies" - ], + "signature": ["DiscoverAppLocatorDependencies"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false, @@ -2583,9 +2430,7 @@ "tags": [], "label": "id", "description": [], - "signature": [ - "\"DISCOVER_ESQL_LOCATOR\"" - ], + "signature": ["\"DISCOVER_ESQL_LOCATOR\""], "path": "src/plugins/discover/common/esql_locator.ts", "deprecated": false, "trackAdoption": false @@ -2597,9 +2442,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "src/plugins/discover/common/esql_locator.ts", "deprecated": false, "trackAdoption": false, @@ -2611,9 +2454,7 @@ "tags": [], "label": "deps", "description": [], - "signature": [ - "DiscoverESQLLocatorDependencies" - ], + "signature": ["DiscoverESQLLocatorDependencies"], "path": "src/plugins/discover/common/esql_locator.ts", "deprecated": false, "trackAdoption": false, @@ -2629,11 +2470,7 @@ "tags": [], "label": "getLocation", "description": [], - "signature": [ - "() => Promise<", - "KibanaLocation", - ">" - ], + "signature": ["() => Promise<", "KibanaLocation", ">"], "path": "src/plugins/discover/common/esql_locator.ts", "deprecated": false, "trackAdoption": false, @@ -2680,12 +2517,8 @@ "type": "string", "tags": [], "label": "savedSearchId", - "description": [ - "\nOptionally set saved search ID." - ], - "signature": [ - "string | undefined" - ], + "description": ["\nOptionally set saved search ID."], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2696,12 +2529,8 @@ "type": "string", "tags": [], "label": "dataViewId", - "description": [ - "\nOptionally set index pattern / data view ID." - ], - "signature": [ - "string | undefined" - ], + "description": ["\nOptionally set index pattern / data view ID."], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2710,16 +2539,10 @@ "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.indexPatternId", "type": "string", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "indexPatternId", - "description": [ - "\nDuplication of dataViewId" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nDuplication of dataViewId"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": true, "trackAdoption": false, @@ -2766,7 +2589,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx" } ] }, @@ -2797,9 +2620,7 @@ "type": "Object", "tags": [], "label": "timeRange", - "description": [ - "\nOptionally set the time range in the time picker." - ], + "description": ["\nOptionally set the time range in the time picker."], "signature": [ { "pluginId": "@kbn/es-query", @@ -2820,9 +2641,7 @@ "type": "CompoundType", "tags": [], "label": "refreshInterval", - "description": [ - "\nOptionally set the refresh interval." - ], + "description": ["\nOptionally set the refresh interval."], "signature": [ "(", { @@ -2852,9 +2671,7 @@ "type": "Array", "tags": [], "label": "filters", - "description": [ - "\nOptionally apply filters." - ], + "description": ["\nOptionally apply filters."], "signature": [ { "pluginId": "@kbn/es-query", @@ -2875,9 +2692,7 @@ "type": "CompoundType", "tags": [], "label": "query", - "description": [ - "\nOptionally set a query." - ], + "description": ["\nOptionally set a query."], "signature": [ { "pluginId": "@kbn/es-query", @@ -2909,9 +2724,7 @@ "description": [ "\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2922,12 +2735,8 @@ "type": "string", "tags": [], "label": "searchSessionId", - "description": [ - "\nBackground search session id" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nBackground search session id"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2938,12 +2747,8 @@ "type": "Array", "tags": [], "label": "columns", - "description": [ - "\nColumns displayed in the table" - ], - "signature": [ - "string[] | undefined" - ], + "description": ["\nColumns displayed in the table"], + "signature": ["string[] | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2954,9 +2759,7 @@ "type": "Object", "tags": [], "label": "grid", - "description": [ - "\nData Grid related state" - ], + "description": ["\nData Grid related state"], "signature": [ { "pluginId": "savedSearch", @@ -2977,12 +2780,8 @@ "type": "string", "tags": [], "label": "interval", - "description": [ - "\nUsed interval of the histogram" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nUsed interval of the histogram"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -2993,12 +2792,8 @@ "type": "Array", "tags": [], "label": "sort", - "description": [ - "\nArray of the used sorting [[field,direction],...]" - ], - "signature": [ - "string[][] | undefined" - ], + "description": ["\nArray of the used sorting [[field,direction],...]"], + "signature": ["string[][] | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3009,12 +2804,8 @@ "type": "string", "tags": [], "label": "savedQuery", - "description": [ - "\nid of the used saved query" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nid of the used saved query"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3025,13 +2816,8 @@ "type": "CompoundType", "tags": [], "label": "viewMode", - "description": [ - "\nTable view: Documents vs Field Statistics" - ], - "signature": [ - "VIEW_MODE", - " | undefined" - ], + "description": ["\nTable view: Documents vs Field Statistics"], + "signature": ["VIEW_MODE", " | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3045,9 +2831,7 @@ "description": [ "\nHide mini distribution/preview charts when in Field Statistics mode" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3058,12 +2842,8 @@ "type": "string", "tags": [], "label": "breakdownField", - "description": [ - "\nBreakdown field" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nBreakdown field"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3074,12 +2854,8 @@ "type": "CompoundType", "tags": [], "label": "isAlertResults", - "description": [ - "\nUsed when navigating to particular alert results" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["\nUsed when navigating to particular alert results"], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3090,12 +2866,8 @@ "type": "string", "tags": [], "label": "profile", - "description": [ - "\nThe Discover profile to use" - ], - "signature": [ - "string | undefined" - ], + "description": ["\nThe Discover profile to use"], + "signature": ["string | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3144,9 +2916,7 @@ "tags": [], "label": "isAlertResults", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false @@ -3164,9 +2934,7 @@ "tags": [], "label": "APP_ICON", "description": [], - "signature": [ - "\"discoverApp\"" - ], + "signature": ["\"discoverApp\""], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -3179,9 +2947,7 @@ "tags": [], "label": "DISCOVER_APP_LOCATOR", "description": [], - "signature": [ - "\"DISCOVER_APP_LOCATOR\"" - ], + "signature": ["\"DISCOVER_APP_LOCATOR\""], "path": "src/plugins/discover/common/app_locator.ts", "deprecated": false, "trackAdoption": false, @@ -3275,9 +3041,7 @@ "tags": [], "label": "PLUGIN_ID", "description": [], - "signature": [ - "\"discover\"" - ], + "signature": ["\"discover\""], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "trackAdoption": false, @@ -3286,4 +3050,4 @@ ], "objects": [] } -} \ No newline at end of file +} diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json index 57a4d27052b2..345f207fbadb 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -24,9 +24,7 @@ "type": "Class", "tags": [], "label": "RouteValidationError", - "description": [ - "\nError to return when the validation is not successful." - ], + "description": ["\nError to return when the validation is not successful."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -55,9 +53,7 @@ "tags": [], "label": "Constructor", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -69,9 +65,7 @@ "tags": [], "label": "error", "description": [], - "signature": [ - "string | Error" - ], + "signature": ["string | Error"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -84,9 +78,7 @@ "tags": [], "label": "path", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -130,9 +122,7 @@ "type": "string", "tags": [], "label": "version", - "description": [ - "\nVersion to assign to this route" - ], + "description": ["\nVersion to assign to this route"], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, "trackAdoption": false @@ -143,9 +133,7 @@ "type": "CompoundType", "tags": [], "label": "validate", - "description": [ - "\nValidation for this version of a route" - ], + "description": ["\nValidation for this version of a route"], "signature": [ "false | ", { @@ -170,9 +158,7 @@ "type": "Interface", "tags": [], "label": "AuthRedirectedParams", - "description": [ - "\nResult of auth redirection." - ], + "description": ["\nResult of auth redirection."], "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", "deprecated": false, "trackAdoption": false, @@ -296,9 +282,7 @@ "type": "Interface", "tags": [], "label": "AuthResultParams", - "description": [ - "\nResult of successful authentication." - ], + "description": ["\nResult of successful authentication."], "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", "deprecated": false, "trackAdoption": false, @@ -312,9 +296,7 @@ "description": [ "\nData to associate with an incoming request. Any downstream plugin may get access to the data." ], - "signature": [ - "Record | undefined" - ], + "signature": ["Record | undefined"], "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", "deprecated": false, "trackAdoption": false @@ -577,9 +559,7 @@ "type": "Interface", "tags": [], "label": "CustomHttpResponseOptions", - "description": [ - "\nHTTP response parameters for a response with adjustable status code." - ], + "description": ["\nHTTP response parameters for a response with adjustable status code."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -600,12 +580,8 @@ "type": "Uncategorized", "tags": [], "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "T | undefined" - ], + "description": ["HTTP message to send to the client"], + "signature": ["T | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -616,9 +592,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], + "description": ["HTTP Headers with additional information about response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -639,12 +613,8 @@ "type": "CompoundType", "tags": [], "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Bypass the default error formatting"], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -669,9 +639,7 @@ "type": "Interface", "tags": [], "label": "ErrorHttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], + "description": ["\nHTTP response parameters"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false, @@ -682,9 +650,7 @@ "type": "CompoundType", "tags": [], "label": "body", - "description": [ - "HTTP message to send to the client" - ], + "description": ["HTTP message to send to the client"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -705,9 +671,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], + "description": ["HTTP Headers with additional information about response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -744,9 +708,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "The headers associated with the request." - ], + "description": ["The headers associated with the request."], "signature": [ "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], @@ -760,9 +722,7 @@ "type": "string", "tags": [], "label": "path", - "description": [ - "The path of the request" - ], + "description": ["The path of the request"], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, "trackAdoption": false @@ -774,9 +734,7 @@ "tags": [], "label": "method", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, "trackAdoption": false @@ -788,10 +746,7 @@ "tags": [], "label": "url", "description": [], - "signature": [ - "URL", - " | undefined" - ], + "signature": ["URL", " | undefined"], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, "trackAdoption": false @@ -803,9 +758,7 @@ "tags": [], "label": "app", "description": [], - "signature": [ - "Record | undefined" - ], + "signature": ["Record | undefined"], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, "trackAdoption": false @@ -817,9 +770,7 @@ "tags": [], "label": "auth", "description": [], - "signature": [ - "{ isAuthenticated?: boolean | undefined; } | undefined" - ], + "signature": ["{ isAuthenticated?: boolean | undefined; } | undefined"], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, "trackAdoption": false @@ -857,9 +808,7 @@ "type": "Interface", "tags": [], "label": "FileHttpResponseOptions", - "description": [ - "\nHTTP response parameters for a response with adjustable status code." - ], + "description": ["\nHTTP response parameters for a response with adjustable status code."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -880,12 +829,8 @@ "type": "Uncategorized", "tags": [], "label": "body", - "description": [ - "Attachment content to send to the client" - ], - "signature": [ - "T" - ], + "description": ["Attachment content to send to the client"], + "signature": ["T"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -912,9 +857,7 @@ "description": [ "Explicitly set the attachment content type. Tries to detect the type based on extension and defaults to application/octet-stream" ], - "signature": [ - "string | null | undefined" - ], + "signature": ["string | null | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -928,9 +871,7 @@ "description": [ "Attachment content size in bytes, Tries to detect the content size from body" ], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -941,9 +882,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], + "description": ["HTTP Headers with additional information about response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -964,12 +903,8 @@ "type": "CompoundType", "tags": [], "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Bypass the default error formatting"], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -983,9 +918,7 @@ "description": [ "Bypass filename encoding, only set to true if the filename is already encoded" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -999,9 +932,7 @@ "type": "Interface", "tags": [], "label": "FullValidationConfig", - "description": [ - "\nVersioned route validation" - ], + "description": ["\nVersioned route validation"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1022,9 +953,7 @@ "type": "CompoundType", "tags": [], "label": "request", - "description": [ - "\nValidation to run against route inputs: params, query and body" - ], + "description": ["\nValidation to run against route inputs: params, query and body"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1043,13 +972,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.FullValidationConfig.response", "type": "Object", - "tags": [ - "note" - ], + "tags": ["note"], "label": "response", - "description": [ - "\nValidation to run against route output" - ], + "description": ["\nValidation to run against route output"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1191,9 +1116,7 @@ "type": "Interface", "tags": [], "label": "HttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], + "description": ["\nHTTP response parameters"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1214,12 +1137,8 @@ "type": "Uncategorized", "tags": [], "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "T | undefined" - ], + "description": ["HTTP message to send to the client"], + "signature": ["T | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -1230,9 +1149,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], + "description": ["HTTP Headers with additional information about response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1253,12 +1170,8 @@ "type": "CompoundType", "tags": [], "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Bypass the default error formatting"], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false @@ -1285,9 +1198,7 @@ "type": "string", "tags": [], "label": "name", - "description": [ - "The name of the Kibana server" - ], + "description": ["The name of the Kibana server"], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false @@ -1298,9 +1209,7 @@ "type": "string", "tags": [], "label": "hostname", - "description": [ - "The hostname of the server" - ], + "description": ["The hostname of the server"], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false @@ -1311,9 +1220,7 @@ "type": "number", "tags": [], "label": "port", - "description": [ - "The port the server is listening on" - ], + "description": ["The port the server is listening on"], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false @@ -1324,12 +1231,8 @@ "type": "CompoundType", "tags": [], "label": "protocol", - "description": [ - "The protocol used by the server" - ], - "signature": [ - "\"http\" | \"https\" | \"socket\"" - ], + "description": ["The protocol used by the server"], + "signature": ["\"http\" | \"https\" | \"socket\""], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false @@ -1391,9 +1294,7 @@ "tags": [], "label": "path", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false, @@ -1431,9 +1332,7 @@ "type": "Object", "tags": [], "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], + "description": ["\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1587,9 +1486,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], + "description": ["{@link OnPreRoutingHandler } - function to call."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1637,9 +1534,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], + "description": ["{@link OnPreRoutingHandler } - function to call."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1737,9 +1632,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "{@link OnPostAuthHandler } - function to call." - ], + "description": ["{@link OnPostAuthHandler } - function to call."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1763,9 +1656,7 @@ "type": "Function", "tags": [], "label": "registerOnPreResponse", - "description": [ - "\nTo define custom logic to perform for the server response.\n" - ], + "description": ["\nTo define custom logic to perform for the server response.\n"], "signature": [ "(handler: ", { @@ -1787,9 +1678,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "{@link OnPreResponseHandler } - function to call." - ], + "description": ["{@link OnPreResponseHandler } - function to call."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1813,9 +1702,7 @@ "type": "Object", "tags": [], "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], + "description": ["\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1857,9 +1744,7 @@ "type": "Object", "tags": [], "label": "csp", - "description": [ - "\nThe CSP config used for Kibana." - ], + "description": ["\nThe CSP config used for Kibana."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -1905,9 +1790,7 @@ "type": "Function", "tags": [], "label": "registerRouteHandlerContext", - "description": [ - "\nRegister a context provider for a route handler." - ], + "description": ["\nRegister a context provider for a route handler."], "signature": [ ">(contextName: ContextName, provider: ", { @@ -1937,9 +1820,7 @@ "tags": [], "label": "contextName", "description": [], - "signature": [ - "ContextName" - ], + "signature": ["ContextName"], "path": "packages/core/http/core-http-server/src/http_contract.ts", "deprecated": false, "trackAdoption": false, @@ -2015,9 +1896,7 @@ "type": "Object", "tags": [], "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], + "description": ["\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -2059,9 +1938,7 @@ "type": "Object", "tags": [], "label": "auth", - "description": [ - "\nAuth status.\nSee {@link HttpAuth}" - ], + "description": ["\nAuth status.\nSee {@link HttpAuth}"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -2173,9 +2050,7 @@ "tags": [], "label": "headers", "description": [], - "signature": [ - "{ [x: string]: string | string[]; }" - ], + "signature": ["{ [x: string]: string | string[]; }"], "path": "packages/core/http/core-http-server/src/auth_headers.ts", "deprecated": false, "trackAdoption": false @@ -2245,9 +2120,7 @@ "type": "Interface", "tags": [], "label": "IBasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n" - ], + "description": ["\nAccess or manipulate the Kibana base path\n"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2274,9 +2147,7 @@ "description": [ "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false @@ -2287,9 +2158,7 @@ "type": "Function", "tags": [], "label": "get", - "description": [ - "\nreturns `basePath` value, specific for an incoming request." - ], + "description": ["\nreturns `basePath` value, specific for an incoming request."], "signature": [ "(request: ", { @@ -2336,9 +2205,7 @@ "type": "Function", "tags": [], "label": "set", - "description": [ - "\nsets `basePath` value, specific for an incoming request." - ], + "description": ["\nsets `basePath` value, specific for an incoming request."], "signature": [ "(request: ", { @@ -2383,9 +2250,7 @@ "tags": [], "label": "requestSpecificBasePath", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2400,12 +2265,8 @@ "type": "Function", "tags": [], "label": "prepend", - "description": [ - "\nPrepends `path` with the basePath." - ], - "signature": [ - "(path: string) => string" - ], + "description": ["\nPrepends `path` with the basePath."], + "signature": ["(path: string) => string"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2417,9 +2278,7 @@ "tags": [], "label": "path", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2434,12 +2293,8 @@ "type": "Function", "tags": [], "label": "remove", - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "signature": [ - "(path: string) => string" - ], + "description": ["\nRemoves the prepended basePath from the `path`."], + "signature": ["(path: string) => string"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2451,9 +2306,7 @@ "tags": [], "label": "path", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/base_path.ts", "deprecated": false, "trackAdoption": false, @@ -2484,9 +2337,7 @@ "type": "Function", "tags": [], "label": "registerContext", - "description": [ - "\nRegister a new context provider.\n" - ], + "description": ["\nRegister a new context provider.\n"], "signature": [ " string | null" - ], + "signature": ["() => string | null"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false, @@ -3115,9 +2932,7 @@ "tags": [], "label": "rejectUnauthorized", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false @@ -3129,9 +2944,7 @@ "tags": [], "label": "requestCert", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false @@ -3152,9 +2965,7 @@ "description": [ "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false @@ -3168,9 +2979,7 @@ "description": [ "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." ], - "signature": [ - "Error | undefined" - ], + "signature": ["Error | undefined"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false @@ -3184,9 +2993,7 @@ "description": [ "\nThe string representation of the remote IP address. For example,`'74.125.127.100'` or\n`'2001:4860:a005::68'`. Value may be `undefined` if the socket is destroyed (for example, if\nthe client disconnected)." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/router/socket.ts", "deprecated": false, "trackAdoption": false @@ -3223,9 +3030,7 @@ "type": "string", "tags": [], "label": "routerPath", - "description": [ - "\nResulted path" - ], + "description": ["\nResulted path"], "path": "packages/core/http/core-http-server/src/router/router.ts", "deprecated": false, "trackAdoption": false @@ -3234,13 +3039,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.get", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "get", - "description": [ - "\nRegister a route handler for `GET` request." - ], + "description": ["\nRegister a route handler for `GET` request."], "signature": [ "(route: ", { @@ -4498,7 +4299,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "upgradeAssistant", @@ -5657,9 +5458,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], + "description": ["{@link RouteConfig } - a route configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -5730,9 +5529,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -5765,9 +5562,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -5780,13 +5575,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.post", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "post", - "description": [ - "\nRegister a route handler for `POST` request." - ], + "description": ["\nRegister a route handler for `POST` request."], "signature": [ "(route: ", { @@ -6908,7 +6699,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "upgradeAssistant", @@ -7851,9 +7642,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], + "description": ["{@link RouteConfig } - a route configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -7924,9 +7713,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -7959,9 +7746,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -7974,13 +7759,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.put", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "put", - "description": [ - "\nRegister a route handler for `PUT` request." - ], + "description": ["\nRegister a route handler for `PUT` request."], "signature": [ "(route: ", { @@ -8330,7 +8111,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "upgradeAssistant", @@ -8541,9 +8322,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], + "description": ["{@link RouteConfig } - a route configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -8614,9 +8393,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -8649,9 +8426,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -8664,13 +8439,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.patch", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "patch", - "description": [ - "\nRegister a route handler for `PATCH` request." - ], + "description": ["\nRegister a route handler for `PATCH` request."], "signature": [ "(route: ", { @@ -8827,9 +8598,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], + "description": ["{@link RouteConfig } - a route configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -8900,9 +8669,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -8935,9 +8702,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -8950,13 +8715,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.delete", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "delete", - "description": [ - "\nRegister a route handler for `DELETE` request." - ], + "description": ["\nRegister a route handler for `DELETE` request."], "signature": [ "(route: ", { @@ -9262,7 +9023,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "upgradeAssistant", @@ -9437,9 +9198,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], + "description": ["{@link RouteConfig } - a route configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -9510,9 +9269,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -9545,9 +9302,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -9635,9 +9390,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "{@link RequestHandler } - a route handler to wrap" - ], + "description": ["{@link RequestHandler } - a route handler to wrap"], "signature": [ "(context: Context, request: ", { @@ -9677,9 +9430,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -9712,9 +9463,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -9727,9 +9476,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IRouter.versioned", "type": "Object", - "tags": [ - "experimental" - ], + "tags": ["experimental"], "label": "versioned", "description": [ "\nAn instance very similar to {@link IRouter} that can be used for versioning HTTP routes\nfollowing the Elastic versioning specification.\n" @@ -9757,9 +9504,7 @@ "type": "Interface", "tags": [], "label": "IStaticAssets", - "description": [ - "\nAPIs for creating hrefs to static assets.\n" - ], + "description": ["\nAPIs for creating hrefs to static assets.\n"], "path": "packages/core/http/core-http-server/src/static_assets.ts", "deprecated": false, "trackAdoption": false, @@ -9773,9 +9518,7 @@ "description": [ "\nGets the full href to the current plugin's asset,\ngiven its path relative to the plugin's `public/assets` folder.\n" ], - "signature": [ - "(assetPath: string) => string" - ], + "signature": ["(assetPath: string) => string"], "path": "packages/core/http/core-http-server/src/static_assets.ts", "deprecated": false, "trackAdoption": false, @@ -9787,9 +9530,7 @@ "tags": [], "label": "assetPath", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/static_assets.ts", "deprecated": false, "trackAdoption": false, @@ -9802,16 +9543,12 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.IStaticAssets.prependPublicUrl", "type": "Function", - "tags": [ - "note" - ], + "tags": ["note"], "label": "prependPublicUrl", "description": [ "\nWill return an href, either a path for or full URL with the provided path\nappended to the static assets public base path.\n\nUseful for instances were you need to render your own HTML page and link to\ncertain static assets.\n" ], - "signature": [ - "(pathname: string) => string" - ], + "signature": ["(pathname: string) => string"], "path": "packages/core/http/core-http-server/src/static_assets.ts", "deprecated": false, "trackAdoption": false, @@ -9823,9 +9560,7 @@ "tags": [], "label": "pathname", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/static_assets.ts", "deprecated": false, "trackAdoption": false, @@ -9972,9 +9707,7 @@ "type": "Function", "tags": [], "label": "forbidden", - "description": [ - "\nServer cannot grant access to a resource.\nStatus code: `403`." - ], + "description": ["\nServer cannot grant access to a resource.\nStatus code: `403`."], "signature": [ "(options?: ", { @@ -10149,9 +9882,7 @@ "type": "Function", "tags": [], "label": "customError", - "description": [ - "\nCreates an error response with defined status code and payload." - ], + "description": ["\nCreates an error response with defined status code and payload."], "signature": [ "(options: ", { @@ -10242,9 +9973,7 @@ "type": "Function", "tags": [], "label": "notModified", - "description": [ - "\nContent not modified.\nStatus code: `304`." - ], + "description": ["\nContent not modified.\nStatus code: `304`."], "signature": [ "(options: ", { @@ -10315,9 +10044,7 @@ "type": "Function", "tags": [], "label": "redirected", - "description": [ - "\nRedirect to a different URI.\nStatus code: `302`." - ], + "description": ["\nRedirect to a different URI.\nStatus code: `302`."], "signature": [ "(options: ", { @@ -10376,9 +10103,7 @@ "type": "Interface", "tags": [], "label": "KibanaRequest", - "description": [ - "\nKibana specific abstraction for an incoming request." - ], + "description": ["\nKibana specific abstraction for an incoming request."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -10399,9 +10124,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "\nA identifier to identify this request.\n" - ], + "description": ["\nA identifier to identify this request.\n"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10412,9 +10135,7 @@ "type": "string", "tags": [], "label": "uuid", - "description": [ - "\nA UUID to identify this request.\n" - ], + "description": ["\nA UUID to identify this request.\n"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10425,12 +10146,8 @@ "type": "Object", "tags": [], "label": "url", - "description": [ - "a WHATWG URL standard object." - ], - "signature": [ - "URL" - ], + "description": ["a WHATWG URL standard object."], + "signature": ["URL"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10441,9 +10158,7 @@ "type": "Object", "tags": [], "label": "route", - "description": [ - "matched route details" - ], + "description": ["matched route details"], "signature": [ "{ readonly path: string; readonly method: ", { @@ -10481,9 +10196,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "\nReadonly copy of incoming request headers." - ], + "description": ["\nReadonly copy of incoming request headers."], "signature": [ "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], @@ -10521,13 +10234,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.KibanaRequest.isInternalApiRequest", "type": "boolean", - "tags": [ - "note" - ], + "tags": ["note"], "label": "isInternalApiRequest", - "description": [ - "\nAn internal request has access to internal routes." - ], + "description": ["\nAn internal request has access to internal routes."], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10582,9 +10291,7 @@ "type": "Object", "tags": [], "label": "auth", - "description": [ - "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." - ], + "description": ["\nThe auth status of this request.\nSee {@link KibanaRequestAuth}."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -10604,13 +10311,8 @@ "type": "Object", "tags": [], "label": "rewrittenUrl", - "description": [ - "\nURL rewritten in onPreRouting request interceptor." - ], - "signature": [ - "URL", - " | undefined" - ], + "description": ["\nURL rewritten in onPreRouting request interceptor."], + "signature": ["URL", " | undefined"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10621,12 +10323,8 @@ "type": "Uncategorized", "tags": [], "label": "params", - "description": [ - "\nThe path parameter of this request." - ], - "signature": [ - "Params" - ], + "description": ["\nThe path parameter of this request."], + "signature": ["Params"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10637,12 +10335,8 @@ "type": "Uncategorized", "tags": [], "label": "query", - "description": [ - "\nThe query parameter of this request." - ], - "signature": [ - "Query" - ], + "description": ["\nThe query parameter of this request."], + "signature": ["Query"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10653,12 +10347,8 @@ "type": "Uncategorized", "tags": [], "label": "body", - "description": [ - "\nThe body payload of this request." - ], - "signature": [ - "Body" - ], + "description": ["\nThe body payload of this request."], + "signature": ["Body"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10672,9 +10362,7 @@ "type": "Interface", "tags": [], "label": "KibanaRequestAuth", - "description": [ - "\nAuth status for this request." - ], + "description": ["\nAuth status for this request."], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false, @@ -10701,9 +10389,7 @@ "type": "Interface", "tags": [], "label": "KibanaRequestEvents", - "description": [ - "\nRequest events." - ], + "description": ["\nRequest events."], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false, @@ -10717,10 +10403,7 @@ "description": [ "\nObservable that emits once if and when the request has been aborted." ], - "signature": [ - "Observable", - "" - ], + "signature": ["Observable", ""], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10734,10 +10417,7 @@ "description": [ "\nObservable that emits once if and when the request has been completely handled.\n" ], - "signature": [ - "Observable", - "" - ], + "signature": ["Observable", ""], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10751,9 +10431,7 @@ "type": "Interface", "tags": [], "label": "KibanaRequestRoute", - "description": [ - "\nRequest specific route information exposed to a handler." - ], + "description": ["\nRequest specific route information exposed to a handler."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -10786,9 +10464,7 @@ "tags": [], "label": "method", "description": [], - "signature": [ - "Method" - ], + "signature": ["Method"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10877,10 +10553,7 @@ "tags": [], "label": "rewrittenUrl", "description": [], - "signature": [ - "URL", - " | undefined" - ], + "signature": ["URL", " | undefined"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10892,9 +10565,7 @@ "tags": [], "label": "traceId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10906,9 +10577,7 @@ "tags": [], "label": "measureElu", "description": [], - "signature": [ - "(() => void) | undefined" - ], + "signature": ["(() => void) | undefined"], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false, @@ -10958,9 +10627,7 @@ "tags": [], "label": "access", "description": [], - "signature": [ - "\"public\" | \"internal\"" - ], + "signature": ["\"public\" | \"internal\""], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false @@ -10985,9 +10652,7 @@ "type": "Function", "tags": [], "label": "ok", - "description": [ - "\nThe request has succeeded.\nStatus code: `200`." - ], + "description": ["\nThe request has succeeded.\nStatus code: `200`."], "signature": [ " | Error | Buffer | ", "Stream", @@ -11054,9 +10719,7 @@ "type": "Function", "tags": [], "label": "accepted", - "description": [ - "\nThe request has been accepted for processing.\nStatus code: `202`." - ], + "description": ["\nThe request has been accepted for processing.\nStatus code: `202`."], "signature": [ " | Error | Buffer | ", "Stream", @@ -11230,9 +10893,7 @@ "type": "Function", "tags": [], "label": "next", - "description": [ - "To pass request to the next handler" - ], + "description": ["To pass request to the next handler"], "signature": [ "() => ", { @@ -11303,9 +10964,7 @@ "type": "Function", "tags": [], "label": "next", - "description": [ - "To pass request to the next handler" - ], + "description": ["To pass request to the next handler"], "signature": [ "() => ", { @@ -11331,9 +10990,7 @@ "type": "Interface", "tags": [], "label": "OnPreResponseExtensions", - "description": [ - "\nAdditional data to extend a response." - ], + "description": ["\nAdditional data to extend a response."], "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", "deprecated": false, "trackAdoption": false, @@ -11344,9 +11001,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "additional headers to attach to the response" - ], + "description": ["additional headers to attach to the response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -11370,9 +11025,7 @@ "type": "Interface", "tags": [], "label": "OnPreResponseInfo", - "description": [ - "\nResponse status code." - ], + "description": ["\nResponse status code."], "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", "deprecated": false, "trackAdoption": false, @@ -11397,9 +11050,7 @@ "type": "Interface", "tags": [], "label": "OnPreResponseRender", - "description": [ - "\nAdditional data to extend a response when rendering a new body" - ], + "description": ["\nAdditional data to extend a response when rendering a new body"], "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", "deprecated": false, "trackAdoption": false, @@ -11410,9 +11061,7 @@ "type": "CompoundType", "tags": [], "label": "headers", - "description": [ - "additional headers to attach to the response" - ], + "description": ["additional headers to attach to the response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -11433,9 +11082,7 @@ "type": "string", "tags": [], "label": "body", - "description": [ - "the body to use in the response" - ], + "description": ["the body to use in the response"], "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", "deprecated": false, "trackAdoption": false @@ -11585,9 +11232,7 @@ "type": "Function", "tags": [], "label": "render", - "description": [ - "To override the response with a different body" - ], + "description": ["To override the response with a different body"], "signature": [ "(responseRender: ", { @@ -11640,9 +11285,7 @@ "type": "Function", "tags": [], "label": "next", - "description": [ - "To pass request to the next handler" - ], + "description": ["To pass request to the next handler"], "signature": [ "(responseExtensions?: ", { @@ -11791,9 +11434,7 @@ "type": "Function", "tags": [], "label": "next", - "description": [ - "To pass request to the next handler" - ], + "description": ["To pass request to the next handler"], "signature": [ "() => ", { @@ -11840,9 +11481,7 @@ "tags": [], "label": "url", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", "deprecated": false, "trackAdoption": false, @@ -11860,9 +11499,7 @@ "type": "Interface", "tags": [], "label": "RequestHandlerContextBase", - "description": [ - "\nBase, abstract type for request handler contexts." - ], + "description": ["\nBase, abstract type for request handler contexts."], "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", "deprecated": false, "trackAdoption": false, @@ -11873,9 +11510,7 @@ "type": "Function", "tags": [], "label": "resolve", - "description": [ - "\nAwait all the specified context parts and return them.\n" - ], + "description": ["\nAwait all the specified context parts and return them.\n"], "signature": [ ">(parts: T[]) => Promise<", { @@ -11898,9 +11533,7 @@ "tags": [], "label": "parts", "description": [], - "signature": [ - "T[]" - ], + "signature": ["T[]"], "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", "deprecated": false, "trackAdoption": false, @@ -11918,9 +11551,7 @@ "type": "Interface", "tags": [], "label": "RouteConfig", - "description": [ - "\nRoute specific configuration." - ], + "description": ["\nRoute specific configuration."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -11941,9 +11572,7 @@ "type": "string", "tags": [], "label": "path", - "description": [ - "\nThe endpoint _within_ the router path to register the route.\n" - ], + "description": ["\nThe endpoint _within_ the router path to register the route.\n"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -11978,9 +11607,7 @@ "type": "Object", "tags": [], "label": "options", - "description": [ - "\nAdditional route options {@link RouteConfigOptions}." - ], + "description": ["\nAdditional route options {@link RouteConfigOptions}."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12004,9 +11631,7 @@ "type": "Interface", "tags": [], "label": "RouteConfigOptions", - "description": [ - "\nAdditional route options." - ], + "description": ["\nAdditional route options."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12030,9 +11655,7 @@ "description": [ "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." ], - "signature": [ - "boolean | \"optional\" | undefined" - ], + "signature": ["boolean | \"optional\" | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12046,9 +11669,7 @@ "description": [ "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" ], - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ], + "signature": ["(Method extends \"get\" ? never : boolean) | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12062,9 +11683,7 @@ "description": [ "\nDefines intended request origin of the route:\n- public. The route is public, declared stable and intended for external access.\n In the future, may require an incomming request to contain a specified header.\n- internal. The route is internal and intended for internal access only.\n\nDefaults to 'internal' If not declared," ], - "signature": [ - "\"public\" | \"internal\" | undefined" - ], + "signature": ["\"public\" | \"internal\" | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12075,12 +11694,8 @@ "type": "Object", "tags": [], "label": "tags", - "description": [ - "\nAdditional metadata tag strings to attach to the route." - ], - "signature": [ - "readonly string[] | undefined" - ], + "description": ["\nAdditional metadata tag strings to attach to the route."], + "signature": ["readonly string[] | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12091,9 +11706,7 @@ "type": "Uncategorized", "tags": [], "label": "body", - "description": [ - "\nAdditional body options {@link RouteConfigOptionsBody}." - ], + "description": ["\nAdditional body options {@link RouteConfigOptionsBody}."], "signature": [ "(Method extends \"get\" | \"options\" ? undefined : ", { @@ -12115,9 +11728,7 @@ "type": "Object", "tags": [], "label": "timeout", - "description": [ - "\nDefines per-route timeouts." - ], + "description": ["\nDefines per-route timeouts."], "signature": [ "{ payload?: (Method extends \"get\" | \"options\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" ], @@ -12134,9 +11745,7 @@ "type": "Interface", "tags": [], "label": "RouteConfigOptionsBody", - "description": [ - "\nAdditional body options for a route" - ], + "description": ["\nAdditional body options for a route"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false, @@ -12174,9 +11783,7 @@ "description": [ "\nA mime type string overriding the 'Content-Type' header value received." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12190,9 +11797,7 @@ "description": [ "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." ], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12206,9 +11811,7 @@ "description": [ "\nThe processed payload format. The value must be one of:\n* '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\nBuffer is returned.\n* '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\nare 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\npayloads 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\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], - "signature": [ - "\"data\" | \"stream\" | undefined" - ], + "signature": ["\"data\" | \"stream\" | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12222,9 +11825,7 @@ "description": [ "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* 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\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], - "signature": [ - "boolean | \"gunzip\" | undefined" - ], + "signature": ["boolean | \"gunzip\" | undefined"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false @@ -12340,9 +11941,7 @@ "tags": [], "label": "req", "description": [], - "signature": [ - "Request" - ], + "signature": ["Request"], "path": "packages/core/http/core-http-server/src/router/router.ts", "deprecated": false, "trackAdoption": false, @@ -12355,9 +11954,7 @@ "tags": [], "label": "responseToolkit", "description": [], - "signature": [ - "ResponseToolkit" - ], + "signature": ["ResponseToolkit"], "path": "packages/core/http/core-http-server/src/router/router.ts", "deprecated": false, "trackAdoption": false, @@ -12389,9 +11986,7 @@ "tags": [], "label": "ok", "description": [], - "signature": [ - "(value: T) => { value: T; }" - ], + "signature": ["(value: T) => { value: T; }"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -12403,9 +11998,7 @@ "tags": [], "label": "value", "description": [], - "signature": [ - "T" - ], + "signature": ["T"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -12443,9 +12036,7 @@ "tags": [], "label": "error", "description": [], - "signature": [ - "string | Error" - ], + "signature": ["string | Error"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -12458,9 +12049,7 @@ "tags": [], "label": "path", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false, @@ -12501,9 +12090,7 @@ "type": "CompoundType", "tags": [], "label": "params", - "description": [ - "\nValidation logic for the URL params" - ], + "description": ["\nValidation logic for the URL params"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12524,9 +12111,7 @@ "type": "CompoundType", "tags": [], "label": "query", - "description": [ - "\nValidation logic for the Query params" - ], + "description": ["\nValidation logic for the Query params"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12547,9 +12132,7 @@ "type": "CompoundType", "tags": [], "label": "body", - "description": [ - "\nValidation logic for the body payload" - ], + "description": ["\nValidation logic for the body payload"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12605,9 +12188,7 @@ "type": "Interface", "tags": [], "label": "SessionCookieValidationResult", - "description": [ - "\nReturn type from a function to validate cookie contents." - ], + "description": ["\nReturn type from a function to validate cookie contents."], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12618,9 +12199,7 @@ "type": "boolean", "tags": [], "label": "isValid", - "description": [ - "\nWhether the cookie is valid or not." - ], + "description": ["\nWhether the cookie is valid or not."], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false @@ -12634,9 +12213,7 @@ "description": [ "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false @@ -12650,9 +12227,7 @@ "type": "Interface", "tags": [], "label": "SessionStorage", - "description": [ - "\nProvides an interface to store and retrieve data across requests." - ], + "description": ["\nProvides an interface to store and retrieve data across requests."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12673,12 +12248,8 @@ "type": "Function", "tags": [], "label": "get", - "description": [ - "\nRetrieves session value from the session storage." - ], - "signature": [ - "() => Promise" - ], + "description": ["\nRetrieves session value from the session storage."], + "signature": ["() => Promise"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12691,12 +12262,8 @@ "type": "Function", "tags": [], "label": "set", - "description": [ - "\nPuts current session value into the session storage." - ], - "signature": [ - "(sessionValue: T) => void" - ], + "description": ["\nPuts current session value into the session storage."], + "signature": ["(sessionValue: T) => void"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12707,12 +12274,8 @@ "type": "Uncategorized", "tags": [], "label": "sessionValue", - "description": [ - "- value to put" - ], - "signature": [ - "T" - ], + "description": ["- value to put"], + "signature": ["T"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12727,12 +12290,8 @@ "type": "Function", "tags": [], "label": "clear", - "description": [ - "\nClears current session." - ], - "signature": [ - "() => void" - ], + "description": ["\nClears current session."], + "signature": ["() => void"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12771,9 +12330,7 @@ "type": "string", "tags": [], "label": "name", - "description": [ - "\nName of the session cookie." - ], + "description": ["\nName of the session cookie."], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false @@ -12797,9 +12354,7 @@ "type": "Function", "tags": [], "label": "validate", - "description": [ - "\nFunction called to validate a cookie's decrypted value." - ], + "description": ["\nFunction called to validate a cookie's decrypted value."], "signature": [ "(sessionValue: T | T[]) => ", { @@ -12821,9 +12376,7 @@ "tags": [], "label": "sessionValue", "description": [], - "signature": [ - "T | T[]" - ], + "signature": ["T | T[]"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false, @@ -12854,9 +12407,7 @@ "description": [ "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" ], - "signature": [ - "\"None\" | \"Strict\" | \"Lax\" | undefined" - ], + "signature": ["\"None\" | \"Strict\" | \"Lax\" | undefined"], "path": "packages/core/http/core-http-server/src/session_storage.ts", "deprecated": false, "trackAdoption": false @@ -12870,9 +12421,7 @@ "type": "Interface", "tags": [], "label": "SessionStorageFactory", - "description": [ - "\nSessionStorage factory to bind one to an incoming request" - ], + "description": ["\nSessionStorage factory to bind one to an incoming request"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12951,9 +12500,7 @@ "type": "Interface", "tags": [], "label": "VersionedRoute", - "description": [ - "\nA versioned route" - ], + "description": ["\nA versioned route"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -12974,9 +12521,7 @@ "type": "Function", "tags": [], "label": "addVersion", - "description": [ - "\nAdd a new version of this route" - ], + "description": ["\nAdd a new version of this route"], "signature": [ "

(options: ", { @@ -13060,9 +12605,7 @@ "type": "Function", "tags": [], "label": "handler", - "description": [ - "The request handler for this version of a route" - ], + "description": ["The request handler for this version of a route"], "signature": [ "(context: Ctx, request: ", { @@ -13138,9 +12681,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.VersionedRouter.get", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "get", "description": [], "signature": [ @@ -13940,7 +13481,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "transform", @@ -14145,9 +13686,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.VersionedRouter.put", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "put", "description": [], "signature": [ @@ -14339,7 +13878,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "transform", @@ -14420,9 +13959,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.VersionedRouter.post", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "post", "description": [], "signature": [ @@ -15230,7 +14767,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "transform", @@ -15371,9 +14908,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.VersionedRouter.patch", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "patch", "description": [], "signature": [ @@ -15498,9 +15033,7 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.VersionedRouter.delete", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "delete", "description": [], "signature": [ @@ -15684,7 +15217,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/server.ts" }, { "plugin": "@kbn/core-http-router-server-internal", @@ -15792,9 +15325,7 @@ "tags": [], "label": "unsafe", "description": [], - "signature": [ - "{ body?: boolean | undefined; } | undefined" - ], + "signature": ["{ body?: boolean | undefined; } | undefined"], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, "trackAdoption": false @@ -15822,9 +15353,7 @@ "type": "Enum", "tags": [], "label": "AuthStatus", - "description": [ - "\nStatus indicating an outcome of the authentication." - ], + "description": ["\nStatus indicating an outcome of the authentication."], "path": "packages/core/http/core-http-server/src/auth_state.ts", "deprecated": false, "trackAdoption": false, @@ -15860,18 +15389,10 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.ApiVersion", "type": "Type", - "tags": [ - "note", - "note", - "experimental" - ], + "tags": ["note", "note", "experimental"], "label": "ApiVersion", - "description": [ - "\nA Kibana HTTP API version\n" - ], - "signature": [ - "string" - ], + "description": ["\nA Kibana HTTP API version\n"], + "signature": ["string"], "path": "packages/core/http/core-http-common/src/versioning.ts", "deprecated": false, "trackAdoption": false, @@ -15883,9 +15404,7 @@ "type": "Type", "tags": [], "label": "AuthenticationHandler", - "description": [ - "\nSee {@link AuthToolkit}." - ], + "description": ["\nSee {@link AuthToolkit}."], "signature": [ "(request: ", { @@ -16029,9 +15548,7 @@ "tags": [], "label": "AuthHeaders", "description": [], - "signature": [ - "{ [x: string]: string | string[]; }" - ], + "signature": ["{ [x: string]: string | string[]; }"], "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", "deprecated": false, "trackAdoption": false, @@ -16080,12 +15597,8 @@ "type": "Type", "tags": [], "label": "DestructiveRouteMethod", - "description": [ - "\nSet of HTTP methods changing the state of the server." - ], - "signature": [ - "\"delete\" | \"post\" | \"put\" | \"patch\"" - ], + "description": ["\nSet of HTTP methods changing the state of the server."], + "signature": ["\"delete\" | \"post\" | \"put\" | \"patch\""], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false, @@ -16095,13 +15608,9 @@ "parentPluginId": "@kbn/core-http-server", "id": "def-common.GetAuthHeaders", "type": "Type", - "tags": [ - "return" - ], + "tags": ["return"], "label": "GetAuthHeaders", - "description": [ - "\nGet headers to authenticate a user against Elasticsearch." - ], + "description": ["\nGet headers to authenticate a user against Elasticsearch."], "signature": [ "(request: ", { @@ -16124,9 +15633,7 @@ "path": "packages/core/http/core-http-server/src/auth_headers.ts", "deprecated": false, "trackAdoption": false, - "returnComment": [ - "authentication headers {@link AuthHeaders } for - an incoming request." - ], + "returnComment": ["authentication headers {@link AuthHeaders } for - an incoming request."], "children": [ { "parentPluginId": "@kbn/core-http-server", @@ -16134,9 +15641,7 @@ "type": "Object", "tags": [], "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], + "description": ["{@link KibanaRequest } - an incoming request."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -16193,9 +15698,7 @@ "type": "Object", "tags": [], "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], + "description": ["{@link KibanaRequest } - an incoming request."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -16247,9 +15750,7 @@ "description": [ "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" ], - "signature": [ - "(context: T, ...args: any[]) => any" - ], + "signature": ["(context: T, ...args: any[]) => any"], "path": "packages/core/http/core-http-server/src/router/context_provider.ts", "deprecated": false, "trackAdoption": false, @@ -16262,9 +15763,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "T" - ], + "signature": ["T"], "path": "packages/core/http/core-http-server/src/router/context_provider.ts", "deprecated": false, "trackAdoption": false @@ -16276,9 +15775,7 @@ "tags": [], "label": "args", "description": [], - "signature": [ - "any[]" - ], + "signature": ["any[]"], "path": "packages/core/http/core-http-server/src/router/context_provider.ts", "deprecated": false, "trackAdoption": false @@ -16295,9 +15792,7 @@ "description": [ "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" ], - "signature": [ - "T extends (context: any, ...args: infer U) => any ? U : never" - ], + "signature": ["T extends (context: any, ...args: infer U) => any ? U : never"], "path": "packages/core/http/core-http-server/src/router/context_provider.ts", "deprecated": false, "trackAdoption": false, @@ -16309,9 +15804,7 @@ "type": "Type", "tags": [], "label": "Headers", - "description": [ - "\nHttp request headers to read." - ], + "description": ["\nHttp request headers to read."], "signature": [ "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], @@ -16326,14 +15819,8 @@ "type": "Type", "tags": [], "label": "HttpResponsePayload", - "description": [ - "\nData send to the client as a response payload." - ], - "signature": [ - "string | Record | Buffer | ", - "Stream", - " | undefined" - ], + "description": ["\nData send to the client as a response payload."], + "signature": ["string | Record | Buffer | ", "Stream", " | undefined"], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false, @@ -16391,9 +15878,7 @@ "description": [ "- A partial context object containing only the keys for values provided by plugin dependencies" ], - "signature": [ - "{ [P in Exclude]: Context[P]; }" - ], + "signature": ["{ [P in Exclude]: Context[P]; }"], "path": "packages/core/http/core-http-server/src/router/context_provider.ts", "deprecated": false, "trackAdoption": false @@ -16439,9 +15924,7 @@ "type": "Type", "tags": [], "label": "IsAuthenticated", - "description": [ - "\nReturns authentication status for a request." - ], + "description": ["\nReturns authentication status for a request."], "signature": [ "(request: ", { @@ -16464,9 +15947,7 @@ "type": "Object", "tags": [], "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], + "description": ["{@link KibanaRequest } - an incoming request."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -16623,9 +16104,7 @@ "type": "Type", "tags": [], "label": "KnownHeaders", - "description": [ - "\nSet of well-known HTTP headers." - ], + "description": ["\nSet of well-known HTTP headers."], "signature": [ "\"date\" | \"warning\" | \"location\" | \"range\" | \"from\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], @@ -16640,9 +16119,7 @@ "type": "Type", "tags": [], "label": "KnownKeys", - "description": [ - "\nCreates a Union type of all known keys of a given interface." - ], + "description": ["\nCreates a Union type of all known keys of a given interface."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -16695,9 +16172,7 @@ "type": "Type", "tags": [], "label": "OnPostAuthHandler", - "description": [ - "\nSee {@link OnPostAuthToolkit}." - ], + "description": ["\nSee {@link OnPostAuthToolkit}."], "signature": [ "(request: ", { @@ -16873,9 +16348,7 @@ "type": "Type", "tags": [], "label": "OnPreAuthHandler", - "description": [ - "\nSee {@link OnPreAuthToolkit}." - ], + "description": ["\nSee {@link OnPreAuthToolkit}."], "signature": [ "(request: ", { @@ -17051,9 +16524,7 @@ "type": "Type", "tags": [], "label": "OnPreResponseHandler", - "description": [ - "\nSee {@link OnPreResponseToolkit}." - ], + "description": ["\nSee {@link OnPreResponseToolkit}."], "signature": [ "(request: ", { @@ -17201,9 +16672,7 @@ "type": "Type", "tags": [], "label": "OnPreRoutingHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], + "description": ["\nSee {@link OnPreRoutingToolkit}."], "signature": [ "(request: ", { @@ -17398,9 +16867,7 @@ "type": "Type", "tags": [], "label": "RedirectResponseOptions", - "description": [ - "\nHTTP response parameters for redirection response" - ], + "description": ["\nHTTP response parameters for redirection response"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -17474,9 +16941,7 @@ "description": [ "{@link RequestHandlerContext } - the core context exposed for this request." ], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -17513,9 +16978,7 @@ "description": [ "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." ], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -17529,9 +16992,7 @@ "type": "Type", "tags": [], "label": "RequestHandlerWrapper", - "description": [ - "\nType-safe wrapper for {@link RequestHandler} function." - ], + "description": ["\nType-safe wrapper for {@link RequestHandler} function."], "signature": [ " | Record<\"date\" | \"warning\" | \"location\" | \"range\" | \"from\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>" ], @@ -17754,9 +17203,7 @@ "type": "Type", "tags": [], "label": "RouteContentType", - "description": [ - "\nThe set of supported parseable Content-Types" - ], + "description": ["\nThe set of supported parseable Content-Types"], "signature": [ "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" ], @@ -17771,9 +17218,7 @@ "type": "Type", "tags": [], "label": "RouteMethod", - "description": [ - "\nThe set of common HTTP methods supported by Kibana routing." - ], + "description": ["\nThe set of common HTTP methods supported by Kibana routing."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -17802,9 +17247,7 @@ "type": "Type", "tags": [], "label": "RouteRegistrar", - "description": [ - "\nRoute handler common definition\n" - ], + "description": ["\nRoute handler common definition\n"], "signature": [ "(route: ", { @@ -17912,9 +17355,7 @@ "tags": [], "label": "context", "description": [], - "signature": [ - "Context" - ], + "signature": ["Context"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -17947,9 +17388,7 @@ "tags": [], "label": "response", "description": [], - "signature": [ - "ResponseFactory" - ], + "signature": ["ResponseFactory"], "path": "packages/core/http/core-http-server/src/router/request_handler.ts", "deprecated": false, "trackAdoption": false @@ -17999,9 +17438,7 @@ "tags": [], "label": "data", "description": [], - "signature": [ - "any" - ], + "signature": ["any"], "path": "packages/core/http/core-http-server/src/router/route_validator.ts", "deprecated": false, "trackAdoption": false @@ -18075,9 +17512,7 @@ "type": "Type", "tags": [], "label": "RouteValidatorFullConfig", - "description": [ - "\nRoute validations config and options merged into one object" - ], + "description": ["\nRoute validations config and options merged into one object"], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -18106,12 +17541,8 @@ "type": "Type", "tags": [], "label": "SafeRouteMethod", - "description": [ - "\nSet of HTTP methods not changing the state of the server." - ], - "signature": [ - "\"get\" | \"options\"" - ], + "description": ["\nSet of HTTP methods not changing the state of the server."], + "signature": ["\"get\" | \"options\""], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false, @@ -18176,9 +17607,7 @@ "tags": [], "label": "headers", "description": [], - "signature": [ - "{ [x: string]: string | string[]; }" - ], + "signature": ["{ [x: string]: string | string[]; }"], "path": "packages/core/http/core-http-server/src/auth_headers.ts", "deprecated": false, "trackAdoption": false @@ -18209,9 +17638,7 @@ "type": "Type", "tags": [], "label": "VersionedRouteConfig", - "description": [ - "\nConfiguration for a versioned route" - ], + "description": ["\nConfiguration for a versioned route"], "signature": [ "Omit<", { @@ -18242,9 +17669,7 @@ "type": "Type", "tags": [], "label": "VersionedRouteRegistrar", - "description": [ - "\nCreate an {@link VersionedRoute | versioned route}.\n" - ], + "description": ["\nCreate an {@link VersionedRoute | versioned route}.\n"], "signature": [ "(config: ", { @@ -18267,9 +17692,7 @@ "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, "trackAdoption": false, - "returnComment": [ - "A versioned route" - ], + "returnComment": ["A versioned route"], "children": [ { "parentPluginId": "@kbn/core-http-server", @@ -18277,9 +17700,7 @@ "type": "CompoundType", "tags": [], "label": "config", - "description": [ - "- The route configuration" - ], + "description": ["- The route configuration"], "signature": [ "Omit<", { @@ -18343,12 +17764,8 @@ "type": "Object", "tags": [], "label": "validBodyOutput", - "description": [ - "\nThe set of valid body.output" - ], - "signature": [ - "readonly [\"data\", \"stream\"]" - ], + "description": ["\nThe set of valid body.output"], + "signature": ["readonly [\"data\", \"stream\"]"], "path": "packages/core/http/core-http-server/src/router/route.ts", "deprecated": false, "trackAdoption": false, @@ -18356,4 +17773,4 @@ } ] } -} \ No newline at end of file +} diff --git a/api_docs/kbn_core_saved_objects_server.devdocs.json b/api_docs/kbn_core_saved_objects_server.devdocs.json index 3581cd6f7ff2..4ed98ce5e6e5 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -37,9 +37,7 @@ "type": "Function", "tags": [], "label": "isSavedObjectsClientError", - "description": [ - "\nDetermines if an error is a saved objects client error" - ], + "description": ["\nDetermines if an error is a saved objects client error"], "signature": [ "(error: any) => error is ", { @@ -60,21 +58,15 @@ "type": "Any", "tags": [], "label": "error", - "description": [ - "the error to check" - ], - "signature": [ - "any" - ], + "description": ["the error to check"], + "signature": ["any"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a saved objects client error" - ] + "returnComment": ["boolean - true if error is a saved objects client error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -82,9 +74,7 @@ "type": "Function", "tags": [], "label": "decorateBadRequestError", - "description": [ - "\nDecorates a bad request error (400) by adding a reason" - ], + "description": ["\nDecorates a bad request error (400) by adding a reason"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -105,12 +95,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -122,21 +108,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the bad request (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the bad request (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -167,21 +147,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the bad request (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the bad request (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -212,21 +186,15 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "the unsupported saved object type" - ], - "signature": [ - "string" - ], + "description": ["the unsupported saved object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -234,9 +202,7 @@ "type": "Function", "tags": [], "label": "isBadRequestError", - "description": [ - "\nDetermines if an error is a bad request error (400)" - ], + "description": ["\nDetermines if an error is a bad request error (400)"], "signature": [ "(error: Error | ", { @@ -258,9 +224,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -277,9 +241,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a bad request error" - ] + "returnComment": ["boolean - true if error is a bad request error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -310,21 +272,15 @@ "type": "string", "tags": [], "label": "versionInput", - "description": [ - "the version string (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the version string (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -356,9 +312,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -375,9 +329,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is an invalid version error" - ] + "returnComment": ["boolean - true if error is an invalid version error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -385,9 +337,7 @@ "type": "Function", "tags": [], "label": "decorateNotAuthorizedError", - "description": [ - "\nDecorates an error as an not authorized error (401)" - ], + "description": ["\nDecorates an error as an not authorized error (401)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -408,12 +358,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -425,21 +371,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the not authorized error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the not authorized error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -447,9 +387,7 @@ "type": "Function", "tags": [], "label": "isNotAuthorizedError", - "description": [ - "\nDetermines if an error is a not authorized error (401)" - ], + "description": ["\nDetermines if an error is a not authorized error (401)"], "signature": [ "(error: Error | ", { @@ -471,9 +409,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -490,9 +426,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a not authorized error" - ] + "returnComment": ["boolean - true if error is a not authorized error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -500,9 +434,7 @@ "type": "Function", "tags": [], "label": "decorateForbiddenError", - "description": [ - "\nDecorates an error as a forbidden error (403)" - ], + "description": ["\nDecorates an error as a forbidden error (403)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -523,12 +455,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -540,21 +468,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the forbidden error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the forbidden error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -562,9 +484,7 @@ "type": "Function", "tags": [], "label": "isForbiddenError", - "description": [ - "\nDetermines if an error is a forbidden error (403)" - ], + "description": ["\nDetermines if an error is a forbidden error (403)"], "signature": [ "(error: Error | ", { @@ -586,9 +506,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -605,9 +523,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a forbidden error" - ] + "returnComment": ["boolean - true if error is a forbidden error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -615,9 +531,7 @@ "type": "Function", "tags": [], "label": "decorateRequestEntityTooLargeError", - "description": [ - "\nDecorates a request entity too large error (413)" - ], + "description": ["\nDecorates a request entity too large error (413)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -638,12 +552,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -655,21 +565,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the request entity too large error" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the request entity too large error"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -677,9 +581,7 @@ "type": "Function", "tags": [], "label": "isRequestEntityTooLargeError", - "description": [ - "\nDetermines if an error is a request entity too large error(413)" - ], + "description": ["\nDetermines if an error is a request entity too large error(413)"], "signature": [ "(error: Error | ", { @@ -701,9 +603,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -720,9 +620,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a request entity too large error" - ] + "returnComment": ["boolean - true if error is a request entity too large error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -730,9 +628,7 @@ "type": "Function", "tags": [], "label": "createGenericNotFoundError", - "description": [ - "\nCreates a generic not found error (404)" - ], + "description": ["\nCreates a generic not found error (404)"], "signature": [ "(type?: string | null, id?: string | null) => ", { @@ -753,12 +649,8 @@ "type": "CompoundType", "tags": [], "label": "type", - "description": [ - "the saved object type or null (default is null)" - ], - "signature": [ - "string | null" - ], + "description": ["the saved object type or null (default is null)"], + "signature": ["string | null"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -770,21 +662,15 @@ "type": "CompoundType", "tags": [], "label": "id", - "description": [ - "the saved object id or null (default is null)" - ], - "signature": [ - "string | null" - ], + "description": ["the saved object id or null (default is null)"], + "signature": ["string | null"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -792,9 +678,7 @@ "type": "Function", "tags": [], "label": "createIndexAliasNotFoundError", - "description": [ - "\nCreates an alias not found error (flavor of general error 500)" - ], + "description": ["\nCreates an alias not found error (flavor of general error 500)"], "signature": [ "(alias: string) => ", { @@ -815,21 +699,15 @@ "type": "string", "tags": [], "label": "alias", - "description": [ - "the unfound saved object alias" - ], - "signature": [ - "string" - ], + "description": ["the unfound saved object alias"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -860,12 +738,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -877,21 +751,15 @@ "type": "string", "tags": [], "label": "alias", - "description": [ - "the unfound index alias" - ], - "signature": [ - "string" - ], + "description": ["the unfound index alias"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -899,9 +767,7 @@ "type": "Function", "tags": [], "label": "isNotFoundError", - "description": [ - "\nDetermines if an error is a not found error (404)" - ], + "description": ["\nDetermines if an error is a not found error (404)"], "signature": [ "(error: Error | ", { @@ -923,9 +789,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -942,9 +806,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a not found error" - ] + "returnComment": ["boolean - true if error is a not found error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -952,9 +814,7 @@ "type": "Function", "tags": [], "label": "decorateConflictError", - "description": [ - "\nDecorates a conflict error (409)" - ], + "description": ["\nDecorates a conflict error (409)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -975,12 +835,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -992,21 +848,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the conflict error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the conflict error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1014,9 +864,7 @@ "type": "Function", "tags": [], "label": "createConflictError", - "description": [ - "\nCreates a conflict error (409)" - ], + "description": ["\nCreates a conflict error (409)"], "signature": [ "(type: string, id: string, reason?: string | undefined) => ", { @@ -1037,12 +885,8 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "the saved object type" - ], - "signature": [ - "string" - ], + "description": ["the saved object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1054,12 +898,8 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "the saved object id" - ], - "signature": [ - "string" - ], + "description": ["the saved object id"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1071,21 +911,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the conflict error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the conflict error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1093,9 +927,7 @@ "type": "Function", "tags": [], "label": "isConflictError", - "description": [ - "\nDetermines if an error is a conflict error (409)" - ], + "description": ["\nDetermines if an error is a conflict error (409)"], "signature": [ "(error: Error | ", { @@ -1117,9 +949,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -1136,9 +966,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a conflict error" - ] + "returnComment": ["boolean - true if error is a conflict error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1146,9 +974,7 @@ "type": "Function", "tags": [], "label": "decorateTooManyRequestsError", - "description": [ - "\nDecorates a too many requests error (429)" - ], + "description": ["\nDecorates a too many requests error (429)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -1169,12 +995,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1186,21 +1008,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the too many requests error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the too many requests error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1208,9 +1024,7 @@ "type": "Function", "tags": [], "label": "createTooManyRequestsError", - "description": [ - "\nCreates a too many requests error (429)" - ], + "description": ["\nCreates a too many requests error (429)"], "signature": [ "(type: string, id: string) => ", { @@ -1231,12 +1045,8 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "the saved object type" - ], - "signature": [ - "string" - ], + "description": ["the saved object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1248,21 +1058,15 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "the saved object id" - ], - "signature": [ - "string" - ], + "description": ["the saved object id"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1270,9 +1074,7 @@ "type": "Function", "tags": [], "label": "isTooManyRequestsError", - "description": [ - "\nDetermines if an error is a too many requests error (429)" - ], + "description": ["\nDetermines if an error is a too many requests error (429)"], "signature": [ "(error: Error | ", { @@ -1294,9 +1096,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -1313,9 +1113,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a too many requests error" - ] + "returnComment": ["boolean - true if error is a too many requests error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1346,12 +1144,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1363,21 +1157,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the cannot execute error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the cannot execute error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1409,9 +1197,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -1428,9 +1214,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a cannot execute error" - ] + "returnComment": ["boolean - true if error is a cannot execute error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1438,9 +1222,7 @@ "type": "Function", "tags": [], "label": "decorateEsUnavailableError", - "description": [ - "\nDecorates an elastic search unavailable error (503)" - ], + "description": ["\nDecorates an elastic search unavailable error (503)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -1461,12 +1243,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1478,21 +1256,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the elastic search unavailable error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the elastic search unavailable error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1524,9 +1296,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -1543,9 +1313,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is an elastic search unavailable error" - ] + "returnComment": ["boolean - true if error is an elastic search unavailable error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1553,9 +1321,7 @@ "type": "Function", "tags": [], "label": "decorateGeneralError", - "description": [ - "\nDecorates a general error (500)" - ], + "description": ["\nDecorates a general error (500)"], "signature": [ "(error: Error, reason?: string | undefined) => ", { @@ -1576,12 +1342,8 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "the error to decorate" - ], - "signature": [ - "Error" - ], + "description": ["the error to decorate"], + "signature": ["Error"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1593,21 +1355,15 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "the reason for the error (optional)" - ], - "signature": [ - "string | undefined" - ], + "description": ["the reason for the error (optional)"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1615,9 +1371,7 @@ "type": "Function", "tags": [], "label": "isGeneralError", - "description": [ - "\nDetermines if an error is a general error (500)" - ], + "description": ["\nDetermines if an error is a general error (500)"], "signature": [ "(error: Error | ", { @@ -1639,9 +1393,7 @@ "type": "CompoundType", "tags": [], "label": "error", - "description": [ - "the error or decorated error" - ], + "description": ["the error or decorated error"], "signature": [ "Error | ", { @@ -1658,9 +1410,7 @@ "isRequired": true } ], - "returnComment": [ - "boolean - true if error is a general error" - ] + "returnComment": ["boolean - true if error is a general error"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -1668,9 +1418,7 @@ "type": "Function", "tags": [], "label": "createGenericNotFoundEsUnavailableError", - "description": [ - "\nCreates a generic elastic search not present error" - ], + "description": ["\nCreates a generic elastic search not present error"], "signature": [ "(type?: string | null, id?: string | null) => ", { @@ -1691,12 +1439,8 @@ "type": "CompoundType", "tags": [], "label": "type", - "description": [ - "the saved object type or null, default null" - ], - "signature": [ - "string | null" - ], + "description": ["the saved object type or null, default null"], + "signature": ["string | null"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -1708,21 +1452,15 @@ "type": "CompoundType", "tags": [], "label": "id", - "description": [ - "the saved object id or null, default null" - ], - "signature": [ - "string | null" - ], + "description": ["the saved object id or null, default null"], + "signature": ["string | null"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "the decorated error" - ] + "returnComment": ["the decorated error"] } ], "initialIsOpen": false @@ -1752,9 +1490,7 @@ "description": [ "\nAn array of authorized spaces for the associated type/action\nin the associated record/map." ], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -1765,12 +1501,8 @@ "type": "CompoundType", "tags": [], "label": "isGloballyAuthorized", - "description": [ - "\nIs the associated type/action globally authorized?" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["\nIs the associated type/action globally authorized?"], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -1808,9 +1540,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "\nThe objects to authorize" - ], + "description": ["\nThe objects to authorize"], "signature": [ "(", { @@ -1867,9 +1597,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-api-server", @@ -1893,10 +1621,7 @@ "description": [ "\noptions for the operation\n- purpose: 'collectMultiNamespaceReferences' or 'updateObjectsSpaces'\ndefault purpose is 'collectMultiNamespaceReferences'." ], - "signature": [ - "MultiNamespaceReferencesOptions", - " | undefined" - ], + "signature": ["MultiNamespaceReferencesOptions", " | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -1934,9 +1659,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -1984,9 +1707,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2043,9 +1764,7 @@ "description": [ "\nThe namespaces to include when retrieving this object. Populated by options\npassed to the repository's update or bulkUpdate method." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2059,9 +1778,7 @@ "description": [ "\nWhether or not an error occurred when getting this object. Populated by\nthe result of a query. Default is false." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2099,9 +1816,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2149,9 +1864,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2199,13 +1912,8 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], - "signature": [ - "AuthorizeObject", - "[]" - ], + "description": ["The objects to authorize"], + "signature": ["AuthorizeObject", "[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2252,9 +1960,7 @@ "description": [ "\nInitial spaces to include the created object. Populated by options\npassed to the repository's bulkCreate method." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2292,9 +1998,7 @@ "type": "Object", "tags": [], "label": "object", - "description": [ - "The object to authorize" - ], + "description": ["The object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2341,12 +2045,8 @@ "type": "Object", "tags": [], "label": "object", - "description": [ - "The object to authorize" - ], - "signature": [ - "AuthorizeObject" - ], + "description": ["The object to authorize"], + "signature": ["AuthorizeObject"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2373,12 +2073,8 @@ "type": "Object", "tags": [], "label": "namespaces", - "description": [ - "The namespaces in which to find objects" - ], - "signature": [ - "Set" - ], + "description": ["The namespaces in which to find objects"], + "signature": ["Set"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2389,12 +2085,8 @@ "type": "Object", "tags": [], "label": "types", - "description": [ - "The types of objects to find" - ], - "signature": [ - "Set" - ], + "description": ["The types of objects to find"], + "signature": ["Set"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2432,9 +2124,7 @@ "type": "Object", "tags": [], "label": "object", - "description": [ - "The object to authorize" - ], + "description": ["The object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2454,12 +2144,8 @@ "type": "CompoundType", "tags": [], "label": "objectNotFound", - "description": [ - "Whether or not the object was not found, defaults to false" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Whether or not the object was not found, defaults to false"], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2500,9 +2186,7 @@ "description": [ "\nSpaces where the object is known to exist. Usually populated\nby document data from the result of an es query." ], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2549,9 +2233,7 @@ "description": [ "\nThe namespace in which to update this object. Populated by options\npassed to the repository's update or bulkUpdate method." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2589,9 +2271,7 @@ "type": "Object", "tags": [], "label": "object", - "description": [ - "The object to authorize" - ], + "description": ["The object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2638,12 +2318,8 @@ "type": "Array", "tags": [], "label": "spacesToAdd", - "description": [ - "The spaces in which to add the objects" - ], - "signature": [ - "string[]" - ], + "description": ["The spaces in which to add the objects"], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2654,12 +2330,8 @@ "type": "Array", "tags": [], "label": "spacesToRemove", - "description": [ - "The spaces from which to remove the objects" - ], - "signature": [ - "string[]" - ], + "description": ["The spaces from which to remove the objects"], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2670,9 +2342,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "The objects to authorize" - ], + "description": ["The objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2696,9 +2366,7 @@ "type": "Interface", "tags": [], "label": "BulkResolveError", - "description": [ - "\nError result for the internal bulk resolve method." - ], + "description": ["\nError result for the internal bulk resolve method."], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false, @@ -2709,9 +2377,7 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "The type of the saved object" - ], + "description": ["The type of the saved object"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false @@ -2722,9 +2388,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "The id of the saved object" - ], + "description": ["The id of the saved object"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false @@ -2735,9 +2399,7 @@ "type": "Object", "tags": [], "label": "error", - "description": [ - "The decorated resolve error" - ], + "description": ["The decorated resolve error"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -2786,9 +2448,7 @@ "description": [ "\nThe overall status of the authorization check as a string:\n'fully_authorized' | 'partially_authorized' | 'unauthorized'" ], - "signature": [ - "\"unauthorized\" | \"fully_authorized\" | \"partially_authorized\"" - ], + "signature": ["\"unauthorized\" | \"fully_authorized\" | \"partially_authorized\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2851,12 +2511,8 @@ "type": "string", "tags": [], "label": "[code]", - "description": [ - "the 'SavedObjectsClientErrorCode' symbol" - ], - "signature": [ - "string | undefined" - ], + "description": ["the 'SavedObjectsClientErrorCode' symbol"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_error_helpers.ts", "deprecated": false, "trackAdoption": false @@ -2883,9 +2539,7 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "The Saved Object type" - ], + "description": ["The Saved Object type"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false @@ -2896,9 +2550,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "The Saved Object ID" - ], + "description": ["The Saved Object ID"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false @@ -2912,9 +2564,7 @@ "description": [ "Namespace for use in index migration...\nIf the object is being decrypted during index migration, the object was previously\nencrypted with its namespace in the descriptor portion of the AAD; on the other hand,\nif the object is being decrypted during object migration, the object was never encrypted\nwith its namespace in the descriptor portion of the AAD." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false @@ -2941,12 +2591,8 @@ "type": "Object", "tags": [], "label": "previouslyCheckedNamespaces", - "description": [ - "The namespaces previously checked by the AuthorizeFind method" - ], - "signature": [ - "Set" - ], + "description": ["The namespaces previously checked by the AuthorizeFind method"], + "signature": ["Set"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false @@ -2996,12 +2642,8 @@ "type": "Function", "tags": [], "label": "isEncryptableType", - "description": [ - "\nReturns true if a type has been registered as encryptable." - ], - "signature": [ - "(type: string) => boolean" - ], + "description": ["\nReturns true if a type has been registered as encryptable."], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false, @@ -3012,21 +2654,15 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "- the string name of the object type" - ], - "signature": [ - "string" - ], + "description": ["- the string name of the object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "boolean, true if type is encryptable" - ] + "returnComment": ["boolean, true if type is encryptable"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -3058,12 +2694,8 @@ "type": "Uncategorized", "tags": [], "label": "response", - "description": [ - "- any object R that extends SavedObject with attributes T" - ], - "signature": [ - "R" - ], + "description": ["- any object R that extends SavedObject with attributes T"], + "signature": ["R"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false, @@ -3078,18 +2710,14 @@ "description": [ "- optional, original attributes T from when the object was created (NOT encrypted).\nThese are used to avoid decryption execution cost if they are supplied." ], - "signature": [ - "T | undefined" - ], + "signature": ["T | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], - "returnComment": [ - "R with decrypted or stripped attributes" - ] + "returnComment": ["R with decrypted or stripped attributes"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -3147,18 +2775,14 @@ "description": [ "- T, attributes of the specified object, some of which to be encrypted." ], - "signature": [ - "T" - ], + "signature": ["T"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/encryption.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "T, encrypted attributes" - ] + "returnComment": ["T, encrypted attributes"] } ], "initialIsOpen": false @@ -3169,9 +2793,7 @@ "type": "Interface", "tags": [], "label": "ISavedObjectsExporter", - "description": [ - "\nUtility class used to export savedObjects.\n" - ], + "description": ["\nUtility class used to export savedObjects.\n"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false, @@ -3180,9 +2802,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.ISavedObjectsExporter.exportByTypes", "type": "Function", - "tags": [ - "throws" - ], + "tags": ["throws"], "label": "exportByTypes", "description": [ "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" @@ -3232,9 +2852,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.ISavedObjectsExporter.exportByObjects", "type": "Function", - "tags": [ - "throws" - ], + "tags": ["throws"], "label": "exportByObjects", "description": [ "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" @@ -3289,9 +2907,7 @@ "type": "Interface", "tags": [], "label": "ISavedObjectsImporter", - "description": [ - "\nUtility class used to import savedObjects.\n" - ], + "description": ["\nUtility class used to import savedObjects.\n"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false, @@ -3300,9 +2916,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.ISavedObjectsImporter.import", "type": "Function", - "tags": [ - "throws" - ], + "tags": ["throws"], "label": "import", "description": [ "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" @@ -3358,9 +2972,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.ISavedObjectsImporter.resolveImportErrors", "type": "Function", - "tags": [ - "throws" - ], + "tags": ["throws"], "label": "resolveImportErrors", "description": [ "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n" @@ -3434,9 +3046,7 @@ "type": "Function", "tags": [], "label": "authorizeCreate", - "description": [ - "\nPerforms authorization for the CREATE security action" - ], + "description": ["\nPerforms authorization for the CREATE security action"], "signature": [ "(params: ", { @@ -3466,9 +3076,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and object to authorize" - ], + "description": ["the namespace and object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3494,9 +3102,7 @@ "type": "Function", "tags": [], "label": "authorizeBulkCreate", - "description": [ - "\nPerforms authorization for the BULK_CREATE security action" - ], + "description": ["\nPerforms authorization for the BULK_CREATE security action"], "signature": [ "(params: ", { @@ -3526,9 +3132,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and objects to authorize" - ], + "description": ["the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3554,9 +3158,7 @@ "type": "Function", "tags": [], "label": "authorizeUpdate", - "description": [ - "\nPerforms authorization for the UPDATE security action" - ], + "description": ["\nPerforms authorization for the UPDATE security action"], "signature": [ "(params: ", { @@ -3586,9 +3188,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and object to authorize" - ], + "description": ["the namespace and object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3614,9 +3214,7 @@ "type": "Function", "tags": [], "label": "authorizeBulkUpdate", - "description": [ - "\nPerforms authorization for the BULK_UPDATE security action" - ], + "description": ["\nPerforms authorization for the BULK_UPDATE security action"], "signature": [ "(params: ", { @@ -3646,9 +3244,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and objects to authorize" - ], + "description": ["the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3674,9 +3270,7 @@ "type": "Function", "tags": [], "label": "authorizeDelete", - "description": [ - "\nPerforms authorization for the DELETE security action" - ], + "description": ["\nPerforms authorization for the DELETE security action"], "signature": [ "(params: ", { @@ -3706,9 +3300,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and object to authorize" - ], + "description": ["the namespace and object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3734,9 +3326,7 @@ "type": "Function", "tags": [], "label": "authorizeBulkDelete", - "description": [ - "\nPerforms authorization for the BULK_DELETE security action" - ], + "description": ["\nPerforms authorization for the BULK_DELETE security action"], "signature": [ "(params: ", { @@ -3766,9 +3356,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and objects to authorize" - ], + "description": ["the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3794,9 +3382,7 @@ "type": "Function", "tags": [], "label": "authorizeGet", - "description": [ - "\nPerforms authorization for the GET security action" - ], + "description": ["\nPerforms authorization for the GET security action"], "signature": [ "(params: ", { @@ -3854,9 +3440,7 @@ "type": "Function", "tags": [], "label": "authorizeBulkGet", - "description": [ - "\nPerforms authorization for the BULK_GET security action" - ], + "description": ["\nPerforms authorization for the BULK_GET security action"], "signature": [ "(params: ", { @@ -3886,9 +3470,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and objects to authorize" - ], + "description": ["the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -3914,9 +3496,7 @@ "type": "Function", "tags": [], "label": "authorizeCheckConflicts", - "description": [ - "\nPerforms authorization for the CHECK_CONFLICTS security action" - ], + "description": ["\nPerforms authorization for the CHECK_CONFLICTS security action"], "signature": [ "(params: ", { @@ -3946,9 +3526,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and objects to authorize" - ], + "description": ["the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4006,9 +3584,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespace and object to authorize" - ], + "description": ["the namespace and object to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4034,9 +3610,7 @@ "type": "Function", "tags": [], "label": "authorizeOpenPointInTime", - "description": [ - "\nPerforms authorization for the OPEN_POINT_IN_TIME security action" - ], + "description": ["\nPerforms authorization for the OPEN_POINT_IN_TIME security action"], "signature": [ "(params: ", { @@ -4066,9 +3640,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "the namespaces and types to authorize" - ], + "description": ["the namespaces and types to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4094,12 +3666,8 @@ "type": "Function", "tags": [], "label": "auditClosePointInTime", - "description": [ - "\nPerforms audit logging for the CLOSE_POINT_IN_TIME security action" - ], - "signature": [ - "() => void" - ], + "description": ["\nPerforms audit logging for the CLOSE_POINT_IN_TIME security action"], + "signature": ["() => void"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false, @@ -4162,9 +3730,7 @@ "isRequired": true } ], - "returnComment": [ - "SavedObjectReferenceWithContext[] - array of collected references" - ] + "returnComment": ["SavedObjectReferenceWithContext[] - array of collected references"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -4212,9 +3778,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "- the namespace and objects to authorize" - ], + "description": ["- the namespace and objects to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4333,9 +3897,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "- namespaces and types to authorize" - ], + "description": ["- namespaces and types to authorize"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4411,9 +3973,7 @@ "isRequired": true } ], - "returnComment": [ - "- the updated type map used for redaction" - ] + "returnComment": ["- the updated type map used for redaction"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -4453,9 +4013,7 @@ "type": "Object", "tags": [], "label": "params", - "description": [ - "- the saved object and an authorization map" - ], + "description": ["- the saved object and an authorization map"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4472,9 +4030,7 @@ "isRequired": true } ], - "returnComment": [ - "SavedObject - saved object with filtered spaces" - ] + "returnComment": ["SavedObject - saved object with filtered spaces"] }, { "parentPluginId": "@kbn/core-saved-objects-server", @@ -4506,9 +4062,7 @@ "type": "Array", "tags": [], "label": "aliases", - "description": [ - "- array of legacy url alias targets" - ], + "description": ["- array of legacy url alias targets"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -4557,12 +4111,8 @@ "type": "string", "tags": [], "label": "spaceId", - "description": [ - "- the id of the space being deleted" - ], - "signature": [ - "string" - ], + "description": ["- the id of the space being deleted"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/security.ts", "deprecated": false, "trackAdoption": false, @@ -4574,9 +4124,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "- the objects to audit" - ], + "description": ["- the objects to audit"], "signature": [ { "pluginId": "@kbn/core-saved-objects-api-server", @@ -4649,9 +4197,7 @@ "type": "Object", "tags": [], "label": "doc", - "description": [ - "- The raw ES document to be tested" - ], + "description": ["- The raw ES document to be tested"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4672,9 +4218,7 @@ "type": "Object", "tags": [], "label": "options", - "description": [ - "- Options for parsing the raw document." - ], + "description": ["- Options for parsing the raw document."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4739,9 +4283,7 @@ "type": "Object", "tags": [], "label": "doc", - "description": [ - "- The raw ES document to be converted to saved object format." - ], + "description": ["- The raw ES document to be converted to saved object format."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4762,9 +4304,7 @@ "type": "Object", "tags": [], "label": "options", - "description": [ - "- Options for parsing the raw document." - ], + "description": ["- Options for parsing the raw document."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4820,9 +4360,7 @@ "type": "CompoundType", "tags": [], "label": "savedObj", - "description": [ - "- The saved object to be converted to raw ES format." - ], + "description": ["- The saved object to be converted to raw ES format."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -4850,9 +4388,7 @@ "description": [ "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n" ], - "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" - ], + "signature": ["(namespace: string | undefined, type: string, id: string) => string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4863,12 +4399,8 @@ "type": "string", "tags": [], "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], - "signature": [ - "string | undefined" - ], + "description": ["- The namespace of the saved object"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4880,12 +4412,8 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "- The saved object type" - ], - "signature": [ - "string" - ], + "description": ["- The saved object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4897,12 +4425,8 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "- The id of the saved object" - ], - "signature": [ - "string" - ], + "description": ["- The id of the saved object"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4920,9 +4444,7 @@ "description": [ "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" ], - "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" - ], + "signature": ["(namespace: string | undefined, type: string, id: string) => string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4933,12 +4455,8 @@ "type": "string", "tags": [], "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], - "signature": [ - "string | undefined" - ], + "description": ["- The namespace of the saved object"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4950,12 +4468,8 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "- The saved object type" - ], - "signature": [ - "string" - ], + "description": ["- The saved object type"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -4967,12 +4481,8 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "- The id of the saved object" - ], - "signature": [ - "string" - ], + "description": ["- The id of the saved object"], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -5006,9 +4516,7 @@ "description": [ "\nRetrieves the active namespace ID. This is *not* the same as a namespace string. See also: `namespaceIdToString` and\n`namespaceStringToId`.\n\nThis takes the saved objects repository's namespace option as a parameter, and doubles as a validation function; if the namespace\noption has already been set some other way, this will throw an error." ], - "signature": [ - "(namespace: string | undefined) => string | undefined" - ], + "signature": ["(namespace: string | undefined) => string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/spaces.ts", "deprecated": false, "trackAdoption": false, @@ -5020,9 +4528,7 @@ "tags": [], "label": "namespace", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/spaces.ts", "deprecated": false, "trackAdoption": false, @@ -5040,9 +4546,7 @@ "description": [ "\nGiven a list of namespace strings, returns a subset that the user is authorized to search in.\nIf a wildcard '*' is used, it is expanded to an explicit list of namespace strings." ], - "signature": [ - "(namespaces: string[] | undefined) => Promise" - ], + "signature": ["(namespaces: string[] | undefined) => Promise"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/spaces.ts", "deprecated": false, "trackAdoption": false, @@ -5054,9 +4558,7 @@ "tags": [], "label": "namespaces", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/spaces.ts", "deprecated": false, "trackAdoption": false, @@ -5112,9 +4614,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5236,9 +4736,7 @@ "description": [ "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5250,9 +4748,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5270,9 +4766,7 @@ "description": [ "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5284,9 +4778,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5304,9 +4796,7 @@ "description": [ "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5318,9 +4808,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5338,9 +4826,7 @@ "description": [ "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5352,9 +4838,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5372,9 +4856,7 @@ "description": [ "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5386,9 +4868,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5406,9 +4886,7 @@ "description": [ "\nReturns the `hiddenFromHttpApis` property for a given type, or `false` if\nthe type is not registered" ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5420,9 +4898,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5440,9 +4916,7 @@ "description": [ "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." ], - "signature": [ - "(type: string) => string | undefined" - ], + "signature": ["(type: string) => string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5454,9 +4928,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5474,9 +4946,7 @@ "description": [ "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." ], - "signature": [ - "(type: string) => boolean" - ], + "signature": ["(type: string) => boolean"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5488,9 +4958,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/type_registry.ts", "deprecated": false, "trackAdoption": false, @@ -5531,9 +4999,7 @@ "type": "Object", "tags": [], "label": "savedObject", - "description": [ - "Relevant saved object" - ], + "description": ["Relevant saved object"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -5581,9 +5047,7 @@ "type": "Interface", "tags": [], "label": "SavedObject", - "description": [ - "\nDefinition of the Saved Object interface\n" - ], + "description": ["\nDefinition of the Saved Object interface\n"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -5633,9 +5097,7 @@ "description": [ "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5646,12 +5108,8 @@ "type": "string", "tags": [], "label": "created_at", - "description": [ - "Timestamp of the time this document had been created." - ], - "signature": [ - "string | undefined" - ], + "description": ["Timestamp of the time this document had been created."], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5662,12 +5120,8 @@ "type": "string", "tags": [], "label": "updated_at", - "description": [ - "Timestamp of the last time this document had been updated." - ], - "signature": [ - "string | undefined" - ], + "description": ["Timestamp of the last time this document had been updated."], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5704,9 +5158,7 @@ "description": [ "The data for a Saved Object is stored as an object in the `attributes` property." ], - "signature": [ - "T" - ], + "signature": ["T"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5717,9 +5169,7 @@ "type": "Array", "tags": [], "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], + "description": ["{@inheritdoc SavedObjectReference}"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -5738,13 +5188,9 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObject.migrationVersion", "type": "Object", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "migrationVersion", - "description": [ - "\n{@inheritdoc SavedObjectsMigrationVersion}" - ], + "description": ["\n{@inheritdoc SavedObjectsMigrationVersion}"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -5958,9 +5404,7 @@ "description": [ "A semver value that is used when upgrading objects between Kibana versions." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5974,9 +5418,7 @@ "description": [ "A semver value that is used when migrating documents between Kibana versions." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -5990,9 +5432,7 @@ "description": [ "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -6006,9 +5446,7 @@ "description": [ "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -6022,9 +5460,7 @@ "description": [ "\nFlag indicating if a saved object is managed by Kibana (default=false)\n\nThis can be leveraged by applications to e.g. prevent edits to a managed\nsaved object. Instead, users can be guided to create a copy first and\nmake their edits to the copy." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false @@ -6036,9 +5472,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectAttributes", "type": "Interface", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" @@ -6343,9 +5777,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectDoc", - "description": [ - "\nSaved Object base document\n" - ], + "description": ["\nSaved Object base document\n"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -6367,9 +5799,7 @@ "tags": [], "label": "attributes", "description": [], - "signature": [ - "T" - ], + "signature": ["T"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6403,9 +5833,7 @@ "tags": [], "label": "namespace", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6417,9 +5845,7 @@ "tags": [], "label": "namespaces", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6452,9 +5878,7 @@ "tags": [], "label": "coreMigrationVersion", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6466,9 +5890,7 @@ "tags": [], "label": "typeMigrationVersion", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6480,9 +5902,7 @@ "tags": [], "label": "version", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6494,9 +5914,7 @@ "tags": [], "label": "updated_at", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6508,9 +5926,7 @@ "tags": [], "label": "created_at", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6522,9 +5938,7 @@ "tags": [], "label": "originId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6536,9 +5950,7 @@ "tags": [], "label": "managed", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -6563,9 +5975,7 @@ "type": "Object", "tags": [], "label": "request", - "description": [ - "The http request initiating the export." - ], + "description": ["The http request initiating the export."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -6586,12 +5996,8 @@ "type": "CompoundType", "tags": [], "label": "includeReferencesDeep", - "description": [ - "flag to also include all related saved objects in the export stream." - ], - "signature": [ - "boolean | undefined" - ], + "description": ["flag to also include all related saved objects in the export stream."], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -6605,9 +6011,7 @@ "description": [ "\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -6621,9 +6025,7 @@ "description": [ "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -6637,9 +6039,7 @@ "description": [ "optional namespace to override the namespace used by the savedObjectsClient." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -6666,9 +6066,7 @@ "type": "Object", "tags": [], "label": "log", - "description": [ - "\nlogger instance to be used by the migration handler" - ], + "description": ["\nlogger instance to be used by the migration handler"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -6688,9 +6086,7 @@ "type": "string", "tags": [], "label": "migrationVersion", - "description": [ - "\nThe migration version that this migration function is defined for" - ], + "description": ["\nThe migration version that this migration function is defined for"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false @@ -6699,16 +6095,12 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", "type": "string", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "convertToMultiNamespaceTypeVersion", "description": [ "\nThe version in which this object type is being converted to a multi-namespace type" ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": true, "trackAdoption": false, @@ -6729,9 +6121,7 @@ "type": "boolean", "tags": [], "label": "isSingleNamespaceType", - "description": [ - "\nWhether this is a single-namespace type or not" - ], + "description": ["\nWhether this is a single-namespace type or not"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false @@ -6783,9 +6173,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectMigrationParams", - "description": [ - "\nSaved Objects migration with parameters." - ], + "description": ["\nSaved Objects migration with parameters."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -6804,16 +6192,12 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectMigrationParams.deferred", "type": "boolean", - "tags": [ - "default" - ], + "tags": ["default"], "label": "deferred", "description": [ "\nA flag that can defer the migration until either an object is accessed (read) or if there is another non-deferred migration with a higher version." ], - "signature": [ - "false | undefined" - ], + "signature": ["false | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false @@ -6824,9 +6208,7 @@ "type": "Function", "tags": [], "label": "transform", - "description": [ - "{@inheritDoc SavedObjectMigrationFn}" - ], + "description": ["{@inheritDoc SavedObjectMigrationFn}"], "signature": [ "(doc: ", { @@ -6943,9 +6325,7 @@ "tags": [], "label": "attributes", "description": [], - "signature": [ - "{ [P in keyof DocAttrs]?: DocAttrs[P] | undefined; }" - ], + "signature": ["{ [P in keyof DocAttrs]?: DocAttrs[P] | undefined; }"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", "deprecated": false, "trackAdoption": false @@ -6972,9 +6352,7 @@ "type": "Object", "tags": [], "label": "log", - "description": [ - "\nlogger instance to be used by the migration handler" - ], + "description": ["\nlogger instance to be used by the migration handler"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -6994,9 +6372,7 @@ "type": "number", "tags": [], "label": "modelVersion", - "description": [ - "\nThe model version this migration is registered for" - ], + "description": ["\nThe model version this migration is registered for"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", "deprecated": false, "trackAdoption": false @@ -7010,9 +6386,7 @@ "description": [ "\nThe namespace type of the savedObject type this migration is registered for" ], - "signature": [ - "\"single\" | \"multiple\" | \"agnostic\" | \"multiple-isolated\"" - ], + "signature": ["\"single\" | \"multiple\" | \"agnostic\" | \"multiple-isolated\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", "deprecated": false, "trackAdoption": false @@ -7081,9 +6455,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectReference", - "description": [ - "\nA reference to another saved object.\n" - ], + "description": ["\nA reference to another saved object.\n"], "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, "trackAdoption": false, @@ -7130,9 +6502,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsClientProviderOptions", - "description": [ - "\nOptions to control the creation of the Saved Objects Client." - ], + "description": ["\nOptions to control the creation of the Saved Objects Client."], "path": "packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts", "deprecated": false, "trackAdoption": false, @@ -7143,12 +6513,8 @@ "type": "Array", "tags": [], "label": "includedHiddenTypes", - "description": [ - "Array of hidden types to include" - ], - "signature": [ - "string[] | undefined" - ], + "description": ["Array of hidden types to include"], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts", "deprecated": false, "trackAdoption": false @@ -7162,9 +6528,7 @@ "description": [ "array of extensions to exclude (ENCRYPTION_EXTENSION_ID | SECURITY_EXTENSION_ID | SPACES_EXTENSION_ID)" ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts", "deprecated": false, "trackAdoption": false @@ -7208,9 +6572,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "optional array of objects to export." - ], + "description": ["optional array of objects to export."], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -7264,12 +6626,8 @@ "type": "Array", "tags": [], "label": "types", - "description": [ - "array of saved object types." - ], - "signature": [ - "string[]" - ], + "description": ["array of saved object types."], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7280,9 +6638,7 @@ "type": "Array", "tags": [], "label": "hasReference", - "description": [ - "optional array of references to search object for." - ], + "description": ["optional array of references to search object for."], "signature": [ { "pluginId": "@kbn/core-saved-objects-api-server", @@ -7303,12 +6659,8 @@ "type": "string", "tags": [], "label": "search", - "description": [ - "optional query string to filter exported objects." - ], - "signature": [ - "string | undefined" - ], + "description": ["optional query string to filter exported objects."], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7333,9 +6685,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "id of the excluded object" - ], + "description": ["id of the excluded object"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7346,9 +6696,7 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "type of the excluded object" - ], + "description": ["type of the excluded object"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7359,12 +6707,8 @@ "type": "string", "tags": [], "label": "reason", - "description": [ - "optional cause of the exclusion" - ], - "signature": [ - "string | undefined" - ], + "description": ["optional cause of the exclusion"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7378,9 +6722,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsExportResultDetails", - "description": [ - "\nStructure of the export result details entry" - ], + "description": ["\nStructure of the export result details entry"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false, @@ -7391,9 +6733,7 @@ "type": "number", "tags": [], "label": "exportedCount", - "description": [ - "number of successfully exported objects" - ], + "description": ["number of successfully exported objects"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7404,9 +6744,7 @@ "type": "number", "tags": [], "label": "missingRefCount", - "description": [ - "number of missing references" - ], + "description": ["number of missing references"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7417,9 +6755,7 @@ "type": "Array", "tags": [], "label": "missingReferences", - "description": [ - "missing references details" - ], + "description": ["missing references details"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -7440,9 +6776,7 @@ "type": "number", "tags": [], "label": "excludedObjectsCount", - "description": [ - "number of objects that were excluded from the export" - ], + "description": ["number of objects that were excluded from the export"], "path": "packages/core/saved-objects/core-saved-objects-server/src/export.ts", "deprecated": false, "trackAdoption": false @@ -7453,9 +6787,7 @@ "type": "Array", "tags": [], "label": "excludedObjects", - "description": [ - "excluded objects details" - ], + "description": ["excluded objects details"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -7603,9 +6935,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsImportHookResult", - "description": [ - "\nResult from a {@link SavedObjectsImportHook | import hook}\n" - ], + "description": ["\nResult from a {@link SavedObjectsImportHook | import hook}\n"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false, @@ -7642,9 +6972,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsImportOptions", - "description": [ - "\nOptions to control the import operation." - ], + "description": ["\nOptions to control the import operation."], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false, @@ -7655,12 +6983,8 @@ "type": "Object", "tags": [], "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to import" - ], - "signature": [ - "Readable" - ], + "description": ["The stream of {@link SavedObject | saved objects} to import"], + "signature": ["Readable"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -7687,9 +7011,7 @@ "description": [ "if specified, will import in given namespace, else will import as global object" ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -7713,12 +7035,8 @@ "type": "CompoundType", "tags": [], "label": "refresh", - "description": [ - "Refresh setting, defaults to `wait_for`" - ], - "signature": [ - "boolean | \"wait_for\" | undefined" - ], + "description": ["Refresh setting, defaults to `wait_for`"], + "signature": ["boolean | \"wait_for\" | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -7732,9 +7050,7 @@ "description": [ "\nIf true, Kibana will apply various adjustments to the data that's being imported to maintain compatibility between\ndifferent Kibana versions (e.g. generate legacy URL aliases for all imported objects that have to change IDs)." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -7748,9 +7064,7 @@ "description": [ "\nIf true, will import as a managed object, else will import as not managed.\n\nThis can be leveraged by applications to e.g. prevent edits to a managed\nsaved object. Instead, users can be guided to create a copy first and\nmake their edits to the copy." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -7813,9 +7127,7 @@ "tags": [], "label": "debug", "description": [], - "signature": [ - "(msg: string) => void" - ], + "signature": ["(msg: string) => void"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7827,9 +7139,7 @@ "tags": [], "label": "msg", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7845,9 +7155,7 @@ "tags": [], "label": "info", "description": [], - "signature": [ - "(msg: string) => void" - ], + "signature": ["(msg: string) => void"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7859,9 +7167,7 @@ "tags": [], "label": "msg", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7877,9 +7183,7 @@ "tags": [], "label": "warn", "description": [], - "signature": [ - "(msg: string) => void" - ], + "signature": ["(msg: string) => void"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7891,9 +7195,7 @@ "tags": [], "label": "msg", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7939,9 +7241,7 @@ "tags": [], "label": "msg", "description": [], - "signature": [ - "string" - ], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7954,9 +7254,7 @@ "tags": [], "label": "meta", "description": [], - "signature": [ - "Meta" - ], + "signature": ["Meta"], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, "trackAdoption": false, @@ -7998,9 +7296,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"data_backfill\"" - ], + "signature": ["\"data_backfill\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8011,9 +7307,7 @@ "type": "Function", "tags": [], "label": "backfillFn", - "description": [ - "\nThe backfill function to run." - ], + "description": ["\nThe backfill function to run."], "signature": [ "(document: ", { @@ -8120,9 +7414,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"data_removal\"" - ], + "signature": ["\"data_removal\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8133,12 +7425,8 @@ "type": "Array", "tags": [], "label": "removedAttributePaths", - "description": [ - "\nThe list of attribute paths to remove." - ], - "signature": [ - "string[]" - ], + "description": ["\nThe list of attribute paths to remove."], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8166,9 +7454,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"mappings_addition\"" - ], + "signature": ["\"mappings_addition\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8179,9 +7465,7 @@ "type": "Object", "tags": [], "label": "addedMappings", - "description": [ - "\nThe new mappings introduced in this version." - ], + "description": ["\nThe new mappings introduced in this version."], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -8218,9 +7502,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"mappings_deprecation\"" - ], + "signature": ["\"mappings_deprecation\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8231,12 +7513,8 @@ "type": "Array", "tags": [], "label": "deprecatedMappings", - "description": [ - "\nA list of paths to mappings to flag as deprecated." - ], - "signature": [ - "string[]" - ], + "description": ["\nA list of paths to mappings to flag as deprecated."], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8274,9 +7552,7 @@ "tags": [], "label": "type", "description": [], - "signature": [ - "\"unsafe_transform\"" - ], + "signature": ["\"unsafe_transform\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", "deprecated": false, "trackAdoption": false @@ -8287,9 +7563,7 @@ "type": "Function", "tags": [], "label": "transformFn", - "description": [ - "\nThe transform function to execute." - ], + "description": ["\nThe transform function to execute."], "signature": [ "(document: ", { @@ -8543,9 +7817,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsRawDoc", - "description": [ - "\nA raw document as represented directly in the saved object index.\n" - ], + "description": ["\nA raw document as represented directly in the saved object index.\n"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false, @@ -8588,9 +7860,7 @@ "tags": [], "label": "_seq_no", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8602,9 +7872,7 @@ "tags": [], "label": "_primary_term", "description": [], - "signature": [ - "number | undefined" - ], + "signature": ["number | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8634,9 +7902,7 @@ "description": [ "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." ], - "signature": [ - "\"strict\" | \"lax\" | undefined" - ], + "signature": ["\"strict\" | \"lax\" | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8645,16 +7911,12 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsRawDocParseOptions.migrationVersionCompatibility", "type": "CompoundType", - "tags": [ - "default" - ], + "tags": ["default"], "label": "migrationVersionCompatibility", "description": [ "\nOptional setting to allow compatible handling of the `migrationVersion` field.\nThis is needed to return the `migrationVersion` field in the same format as it was before migrating to the `typeMigrationVersion` property.\n" ], - "signature": [ - "\"raw\" | \"compatible\" | undefined" - ], + "signature": ["\"raw\" | \"compatible\" | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8693,9 +7955,7 @@ "tags": [], "label": "namespace", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8707,9 +7967,7 @@ "tags": [], "label": "namespaces", "description": [], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8742,9 +8000,7 @@ "tags": [], "label": "typeMigrationVersion", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8756,9 +8012,7 @@ "tags": [], "label": "updated_at", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8770,9 +8024,7 @@ "tags": [], "label": "created_at", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8805,9 +8057,7 @@ "tags": [], "label": "originId", "description": [], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8819,9 +8069,7 @@ "tags": [], "label": "managed", "description": [], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8833,9 +8081,7 @@ "tags": [], "label": "[typeMapping: string]: any", "description": [], - "signature": [ - "[typeMapping: string]: any" - ], + "signature": ["[typeMapping: string]: any"], "path": "packages/core/saved-objects/core-saved-objects-server/src/serialization.ts", "deprecated": false, "trackAdoption": false @@ -8926,9 +8172,7 @@ "description": [ "- A list of additional hidden types the repository should have access to." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts", "deprecated": false, "trackAdoption": false, @@ -9001,9 +8245,7 @@ "description": [ "- A list of additional hidden types the repository should have access to." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts", "deprecated": false, "trackAdoption": false, @@ -9045,9 +8287,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsRequestHandlerContext", - "description": [ - "\nCore's `savedObjects` request handler context." - ], + "description": ["\nCore's `savedObjects` request handler context."], "path": "packages/core/saved-objects/core-saved-objects-server/src/request_handler_context.ts", "deprecated": false, "trackAdoption": false, @@ -9261,9 +8501,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsResolveImportErrorsOptions", - "description": [ - "\nOptions to control the \"resolve import\" operation." - ], + "description": ["\nOptions to control the \"resolve import\" operation."], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false, @@ -9277,9 +8515,7 @@ "description": [ "The stream of {@link SavedObject | saved objects} to resolve errors from" ], - "signature": [ - "Readable" - ], + "signature": ["Readable"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -9290,9 +8526,7 @@ "type": "Array", "tags": [], "label": "retries", - "description": [ - "saved object import references to retry" - ], + "description": ["saved object import references to retry"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -9313,12 +8547,8 @@ "type": "string", "tags": [], "label": "namespace", - "description": [ - "if specified, will import in given namespace" - ], - "signature": [ - "string | undefined" - ], + "description": ["if specified, will import in given namespace"], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -9345,9 +8575,7 @@ "description": [ "\nIf true, Kibana will apply various adjustments to the data that's being retried to import to maintain compatibility between\ndifferent Kibana versions (e.g. generate legacy URL aliases for all imported objects that have to change IDs)." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -9361,9 +8589,7 @@ "description": [ "\nIf true, will import as a managed object, else will import as not managed.\n\nThis can be leveraged by applications to e.g. prevent edits to a managed\nsaved object. Instead, users can be guided to create a copy first and\nmake their edits to the copy." ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/import.ts", "deprecated": false, "trackAdoption": false @@ -9631,12 +8857,8 @@ "type": "Function", "tags": [], "label": "getDefaultIndex", - "description": [ - "\nReturns the default index used for saved objects." - ], - "signature": [ - "() => string" - ], + "description": ["\nReturns the default index used for saved objects."], + "signature": ["() => string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -9790,9 +9012,7 @@ "type": "Object", "tags": [], "label": "req", - "description": [ - "- The request to create the scoped repository from." - ], + "description": ["- The request to create the scoped repository from."], "signature": [ { "pluginId": "@kbn/core-http-server", @@ -9817,9 +9037,7 @@ "description": [ "- A list of additional hidden types the repository should have access to." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -9892,9 +9110,7 @@ "description": [ "- A list of additional hidden types the repository should have access to." ], - "signature": [ - "string[] | undefined" - ], + "signature": ["string[] | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10068,10 +9284,7 @@ "tags": [], "label": "options", "description": [], - "signature": [ - "SavedObjectsImporterOptions", - " | undefined" - ], + "signature": ["SavedObjectsImporterOptions", " | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10114,9 +9327,7 @@ "description": [ "\nReturns the (alias to the) index that the specified saved object type is stored in.\n" ], - "signature": [ - "(type: string) => string" - ], + "signature": ["(type: string) => string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10127,12 +9338,8 @@ "type": "string", "tags": [], "label": "type", - "description": [ - "The SO type to retrieve the index/alias for." - ], - "signature": [ - "string" - ], + "description": ["The SO type to retrieve the index/alias for."], + "signature": ["string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10150,9 +9357,7 @@ "description": [ "\nReturns the (alias to the) index that the specified saved object type is stored in.\n" ], - "signature": [ - "(types: string[]) => string[]" - ], + "signature": ["(types: string[]) => string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10163,12 +9368,8 @@ "type": "Array", "tags": [], "label": "types", - "description": [ - "The SO types to retrieve the index/alias for." - ], - "signature": [ - "string[]" - ], + "description": ["The SO types to retrieve the index/alias for."], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10183,12 +9384,8 @@ "type": "Function", "tags": [], "label": "getDefaultIndex", - "description": [ - "\nReturns the default index used for saved objects." - ], - "signature": [ - "() => string" - ], + "description": ["\nReturns the default index used for saved objects."], + "signature": ["() => string"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10204,9 +9401,7 @@ "description": [ "\nReturns all (aliases to) kibana system indices used for saved object storage.\n" ], - "signature": [ - "() => string[]" - ], + "signature": ["() => string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/contracts.ts", "deprecated": false, "trackAdoption": false, @@ -10236,9 +9431,7 @@ "tags": [], "label": "migratedIndices", "description": [], - "signature": [ - "{ [status: string]: number; skipped: number; migrated: number; }" - ], + "signature": ["{ [status: string]: number; skipped: number; migrated: number; }"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_status.ts", "deprecated": false, "trackAdoption": false @@ -10252,9 +9445,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsType", - "description": [ - "\nDefinition of a type of savedObject.\n" - ], + "description": ["\nDefinition of a type of savedObject.\n"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -10275,9 +9466,7 @@ "type": "string", "tags": [], "label": "name", - "description": [ - "\nThe name of the type, which is also used as the internal id." - ], + "description": ["\nThe name of the type, which is also used as the internal id."], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -10304,9 +9493,7 @@ "description": [ "\nIs the type hidden from the http APIs. If `hiddenFromHttpApis:true`, repositories will have access to the type but the type is not exposed via the HTTP APIs.\nIt is recommended to hide types registered with 'hidden=false' from the httpApis for backward compatibility in the HTTP layer.\n" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -10320,9 +9507,7 @@ "description": [ "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." ], - "signature": [ - "\"single\" | \"multiple\" | \"agnostic\" | \"multiple-isolated\"" - ], + "signature": ["\"single\" | \"multiple\" | \"agnostic\" | \"multiple-isolated\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -10336,9 +9521,7 @@ "description": [ "\nIf defined, the type instances will be stored in the given index instead of the default one." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -10349,12 +9532,8 @@ "type": "string", "tags": [], "label": "convertToAliasScript", - "description": [ - "\nIf defined, will be used to convert the type to an alias." - ], - "signature": [ - "string | undefined" - ], + "description": ["\nIf defined, will be used to convert the type to an alias."], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -10408,9 +9587,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsType.migrations", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "migrations", "description": [ "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." @@ -10679,7 +9856,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/saved_objects/synthetics_monitor.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/saved_objects/synthetics_monitor.ts" }, { "plugin": "uptime", @@ -11111,9 +10288,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsType.schemas", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "schemas", "description": [ "\nAn optional schema that can be used to validate the attributes of the type.\n\nWhen provided, calls to {@link SavedObjectsClient.create | create} will be validated against this schema.\n\nSee {@link SavedObjectsValidationMap} for more details." @@ -11270,16 +10445,12 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion", "type": "string", - "tags": [ - "deprecated" - ], + "tags": ["deprecated"], "label": "convertToMultiNamespaceTypeVersion", "description": [ "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": true, "trackAdoption": false, @@ -11573,9 +10744,7 @@ "description": [ "\nAllows to opt-in to the model version API.\n\nMust be a valid semver version (with the patch version being necessarily 0)\n\nWhen specified, the type will switch from using the {@link SavedObjectsType.migrations | legacy migration API}\nto use the {@link SavedObjectsType.modelVersions | modelVersion API} after the specified version.\n\nOnce opted in, it will no longer be possible to use the legacy migration API after the specified version.\n" ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts", "deprecated": false, "trackAdoption": false @@ -11612,12 +10781,8 @@ "type": "CompoundType", "tags": [], "label": "importableAndExportable", - "description": [ - "\nIs the type importable or exportable. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], + "description": ["\nIs the type importable or exportable. Defaults to `false`."], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_management.ts", "deprecated": false, "trackAdoption": false @@ -11631,9 +10796,7 @@ "description": [ "\nWhen specified, will be used instead of the type's name in SO management section's labels." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_management.ts", "deprecated": false, "trackAdoption": false @@ -11647,9 +10810,7 @@ "description": [ "\nWhen set to false, the type will not be listed or searchable in the SO management section.\nMain usage of setting this property to false for a type is when objects from the type should\nbe included in the export via references or export hooks, but should not directly appear in the SOM.\nDefaults to `true`.\n" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_management.ts", "deprecated": false, "trackAdoption": false @@ -11660,12 +10821,8 @@ "type": "string", "tags": [], "label": "defaultSearchField", - "description": [ - "\nThe default search field to use for this type. Defaults to `id`." - ], - "signature": [ - "string | undefined" - ], + "description": ["\nThe default search field to use for this type. Defaults to `id`."], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_management.ts", "deprecated": false, "trackAdoption": false @@ -11679,9 +10836,7 @@ "description": [ "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_management.ts", "deprecated": false, "trackAdoption": false @@ -11913,9 +11068,7 @@ "type": "Interface", "tags": [], "label": "SavedObjectsTypeMappingDefinition", - "description": [ - "\nDescribe a saved object type mapping.\n" - ], + "description": ["\nDescribe a saved object type mapping.\n"], "path": "packages/core/saved-objects/core-saved-objects-server/src/mapping_definition.ts", "deprecated": false, "trackAdoption": false, @@ -11929,9 +11082,7 @@ "description": [ "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." ], - "signature": [ - "false | \"strict\" | undefined" - ], + "signature": ["false | \"strict\" | undefined"], "path": "packages/core/saved-objects/core-saved-objects-server/src/mapping_definition.ts", "deprecated": false, "trackAdoption": false @@ -11942,9 +11093,7 @@ "type": "Object", "tags": [], "label": "properties", - "description": [ - "The underlying properties of the type mapping" - ], + "description": ["The underlying properties of the type mapping"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -12020,9 +11169,7 @@ "tags": [], "label": "ALL_SAVED_OBJECT_INDICES", "description": [], - "signature": [ - "string[]" - ], + "signature": ["string[]"], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_index_pattern.ts", "deprecated": false, "trackAdoption": false, @@ -12117,9 +11264,7 @@ "tags": [], "label": "ENCRYPTION_EXTENSION_ID", "description": [], - "signature": [ - "\"encryptedSavedObjects\"" - ], + "signature": ["\"encryptedSavedObjects\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/extensions.ts", "deprecated": false, "trackAdoption": false, @@ -12146,9 +11291,7 @@ "description": [ "\nCollect and centralize the names of the different saved object indices.\nNote that all of them start with the '.kibana' prefix.\nThere are multiple places in the code that these indices have the form .kibana*.\nHowever, beware that there are some system indices that have the same prefix\nbut are NOT used to store saved objects, e.g.: .kibana_security_session_1" ], - "signature": [ - "\".kibana\"" - ], + "signature": ["\".kibana\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/saved_objects_index_pattern.ts", "deprecated": false, "trackAdoption": false, @@ -12160,9 +11303,7 @@ "type": "Type", "tags": [], "label": "SavedObjectAttribute", - "description": [ - "\nType definition for a Saved Object attribute value\n" - ], + "description": ["\nType definition for a Saved Object attribute value\n"], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", @@ -12435,9 +11576,7 @@ "type": "Type", "tags": [], "label": "SavedObjectModelTransformationDoc", - "description": [ - "\nDocument type used during model migration.\n" - ], + "description": ["\nDocument type used during model migration.\n"], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", @@ -12656,9 +11795,7 @@ "description": [ "\nPlain javascript function alternative for {@link SavedObjectModelVersionForwardCompatibilitySchema}\n" ], - "signature": [ - "(attributes: InAttrs) => OutAttrs" - ], + "signature": ["(attributes: InAttrs) => OutAttrs"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", "deprecated": false, "trackAdoption": false, @@ -12671,9 +11808,7 @@ "tags": [], "label": "attributes", "description": [], - "signature": [ - "InAttrs" - ], + "signature": ["InAttrs"], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", "deprecated": false, "trackAdoption": false @@ -12848,9 +11983,7 @@ "type": "Type", "tags": [], "label": "SavedObjectsClientFactoryProvider", - "description": [ - "\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}." - ], + "description": ["\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}."], "signature": [ "(repositoryFactory: ", { @@ -13117,9 +12250,7 @@ "type": "Type", "tags": [], "label": "SavedObjectsExtensionFactory", - "description": [ - "\nDescribes the base Saved Objects Extension factory." - ], + "description": ["\nDescribes the base Saved Objects Extension factory."], "signature": [ "(params: { typeRegistry: ", { @@ -13520,9 +12651,7 @@ "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectTypeExcludeFromUpgradeFilterHook", "type": "Type", - "tags": [ - "alpha" - ], + "tags": ["alpha"], "label": "SavedObjectTypeExcludeFromUpgradeFilterHook", "description": [ "\nIf defined, allows a type to run a search query and return a query filter that may match any documents which may\nbe excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which\nare no longer needed and may slow the migration process.\n\nIf this hook fails, the migration will proceed without these documents having been filtered out, so this\nshould not be used as a guarantee that these documents have been deleted.\n" @@ -13617,9 +12746,7 @@ "tags": [], "label": "SECURITY_EXTENSION_ID", "description": [], - "signature": [ - "\"security\"" - ], + "signature": ["\"security\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/extensions.ts", "deprecated": false, "trackAdoption": false, @@ -13644,9 +12771,7 @@ "tags": [], "label": "SPACES_EXTENSION_ID", "description": [], - "signature": [ - "\"spaces\"" - ], + "signature": ["\"spaces\""], "path": "packages/core/saved-objects/core-saved-objects-server/src/extensions/extensions.ts", "deprecated": false, "trackAdoption": false, @@ -13667,4 +12792,4 @@ ], "objects": [] } -} \ No newline at end of file +} diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index da6c35434bff..8468c146eaa0 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -1649,15 +1649,15 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/synthetics_app.tsx" }, { "plugin": "transform", @@ -3134,67 +3134,67 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/state/monitor_list/toast_title.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/browser_test_results.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/delete_monitor.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/show_sync_errors.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/show_sync_errors.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/show_sync_errors.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/management/show_sync_errors.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/simple_test_results.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/simple_test_results.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/simple_test_results.tsx" + "path": "x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/manual_test_run_mode/simple_test_results.tsx" }, { "plugin": "uptime", @@ -5526,4 +5526,4 @@ "misc": [], "objects": [] } -} \ No newline at end of file +} diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json index 6a4b8332f9d4..50dd97e23467 100644 --- a/api_docs/telemetry.devdocs.json +++ b/api_docs/telemetry.devdocs.json @@ -10,9 +10,7 @@ "type": "Interface", "tags": [], "label": "TelemetryConstants", - "description": [ - "\nPublic's start exposed APIs by the telemetry plugin" - ], + "description": ["\nPublic's start exposed APIs by the telemetry plugin"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -23,12 +21,8 @@ "type": "Function", "tags": [], "label": "getPrivacyStatementUrl", - "description": [ - "Elastic's privacy statement url" - ], - "signature": [ - "() => string" - ], + "description": ["Elastic's privacy statement url"], + "signature": ["() => string"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -44,9 +38,7 @@ "type": "Interface", "tags": [], "label": "TelemetryPluginConfig", - "description": [ - "\nPublic-exposed configuration" - ], + "description": ["\nPublic-exposed configuration"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -57,9 +49,7 @@ "type": "boolean", "tags": [], "label": "banner", - "description": [ - "The banner is expected to be shown when needed" - ], + "description": ["The banner is expected to be shown when needed"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -70,9 +60,7 @@ "type": "boolean", "tags": [], "label": "allowChangingOptInStatus", - "description": [ - "Does the cluster allow changing the opt-in/out status via the UI?" - ], + "description": ["Does the cluster allow changing the opt-in/out status via the UI?"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -83,12 +71,8 @@ "type": "CompoundType", "tags": [], "label": "optIn", - "description": [ - "Is the cluster opted-in?" - ], - "signature": [ - "boolean | null" - ], + "description": ["Is the cluster opted-in?"], + "signature": ["boolean | null"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -102,9 +86,7 @@ "description": [ "Specify if telemetry should send usage to the prod or staging remote telemetry service" ], - "signature": [ - "\"prod\" | \"staging\"" - ], + "signature": ["\"prod\" | \"staging\""], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -118,9 +100,7 @@ "description": [ "Should the telemetry payloads be sent from the server or the browser?" ], - "signature": [ - "\"browser\" | \"server\"" - ], + "signature": ["\"browser\" | \"server\""], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -131,12 +111,8 @@ "type": "CompoundType", "tags": [], "label": "telemetryNotifyUserAboutOptInDefault", - "description": [ - "Should notify the user about the opt-in status?" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Should notify the user about the opt-in status?"], + "signature": ["boolean | undefined"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -147,12 +123,8 @@ "type": "CompoundType", "tags": [], "label": "userCanChangeSettings", - "description": [ - "Does the user have enough privileges to change the settings?" - ], - "signature": [ - "boolean | undefined" - ], + "description": ["Does the user have enough privileges to change the settings?"], + "signature": ["boolean | undefined"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -166,9 +138,7 @@ "description": [ "Should we hide the privacy statement notice? Useful on some environments, e.g. Cloud" ], - "signature": [ - "boolean | undefined" - ], + "signature": ["boolean | undefined"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -179,12 +149,8 @@ "type": "Object", "tags": [], "label": "labels", - "description": [ - "Extra labels to add to the telemetry context" - ], - "signature": [ - "{ [x: string]: unknown; }" - ], + "description": ["Extra labels to add to the telemetry context"], + "signature": ["{ [x: string]: unknown; }"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -211,9 +177,7 @@ "type": "Interface", "tags": [], "label": "TelemetryServicePublicApis", - "description": [ - "\nPublicly exposed APIs from the Telemetry Service" - ], + "description": ["\nPublicly exposed APIs from the Telemetry Service"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -224,12 +188,8 @@ "type": "Function", "tags": [], "label": "getIsOptedIn", - "description": [ - "Is the cluster opted-in to telemetry?" - ], - "signature": [ - "() => boolean | null" - ], + "description": ["Is the cluster opted-in to telemetry?"], + "signature": ["() => boolean | null"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -242,9 +202,7 @@ "type": "boolean", "tags": [], "label": "userCanChangeSettings", - "description": [ - "Is the user allowed to change the opt-in/out status?" - ], + "description": ["Is the user allowed to change the opt-in/out status?"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -258,9 +216,7 @@ "description": [ "Can phone-home telemetry calls be made? This depends on whether we have opted-in or if we are rendering a report" ], - "signature": [ - "() => boolean" - ], + "signature": ["() => boolean"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -273,12 +229,8 @@ "type": "Function", "tags": [], "label": "getCanChangeOptInStatus", - "description": [ - "Is the cluster allowed to change the opt-in/out status?" - ], - "signature": [ - "() => boolean" - ], + "description": ["Is the cluster allowed to change the opt-in/out status?"], + "signature": ["() => boolean"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -294,9 +246,7 @@ "description": [ "Fetches an unencrypted telemetry payload so we can show it to the user" ], - "signature": [ - "() => Promise" - ], + "signature": ["() => Promise"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -312,9 +262,7 @@ "description": [ "\nOverwrite the opt-in status.\nIt will send a final request to the remote telemetry cluster to report about the opt-in/out change." ], - "signature": [ - "(optedIn: boolean) => Promise" - ], + "signature": ["(optedIn: boolean) => Promise"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -325,12 +273,8 @@ "type": "boolean", "tags": [], "label": "optedIn", - "description": [ - "Whether the user is opting-in (`true`) or out (`false`)." - ], - "signature": [ - "boolean" - ], + "description": ["Whether the user is opting-in (`true`) or out (`false`)."], + "signature": ["boolean"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -363,9 +307,7 @@ "type": "Object", "tags": [], "label": "telemetryService", - "description": [ - "{@link TelemetryServicePublicApis}" - ], + "description": ["{@link TelemetryServicePublicApis}"], "signature": [ { "pluginId": "telemetry", @@ -385,12 +327,8 @@ "type": "Object", "tags": [], "label": "telemetryNotifications", - "description": [ - "Notification helpers" - ], - "signature": [ - "{ setOptedInNoticeSeen: () => Promise; }" - ], + "description": ["Notification helpers"], + "signature": ["{ setOptedInNoticeSeen: () => Promise; }"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false @@ -401,9 +339,7 @@ "type": "Object", "tags": [], "label": "telemetryConstants", - "description": [ - "Set of publicly exposed telemetry constants" - ], + "description": ["Set of publicly exposed telemetry constants"], "signature": [ { "pluginId": "telemetry", @@ -427,9 +363,7 @@ "type": "Interface", "tags": [], "label": "TelemetryPluginSetup", - "description": [ - "\nPublic's setup exposed APIs by the telemetry plugin" - ], + "description": ["\nPublic's setup exposed APIs by the telemetry plugin"], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -440,9 +374,7 @@ "type": "Object", "tags": [], "label": "telemetryService", - "description": [ - "{@link TelemetryService}" - ], + "description": ["{@link TelemetryService}"], "signature": [ { "pluginId": "telemetry", @@ -471,9 +403,7 @@ "type": "Interface", "tags": [], "label": "DataTelemetryBasePayload", - "description": [ - "\nCommon counters for the {@link DataTelemetryDocument}s" - ], + "description": ["\nCommon counters for the {@link DataTelemetryDocument}s"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false, @@ -484,9 +414,7 @@ "type": "number", "tags": [], "label": "index_count", - "description": [ - "How many indices match the declared pattern" - ], + "description": ["How many indices match the declared pattern"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -497,12 +425,8 @@ "type": "number", "tags": [], "label": "ecs_index_count", - "description": [ - "How many indices match the declared pattern follow ECS conventions" - ], - "signature": [ - "number | undefined" - ], + "description": ["How many indices match the declared pattern follow ECS conventions"], + "signature": ["number | undefined"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -513,12 +437,8 @@ "type": "number", "tags": [], "label": "doc_count", - "description": [ - "How many documents are among all the identified indices" - ], - "signature": [ - "number | undefined" - ], + "description": ["How many documents are among all the identified indices"], + "signature": ["number | undefined"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -529,12 +449,8 @@ "type": "number", "tags": [], "label": "size_in_bytes", - "description": [ - "Total size in bytes among all the identified indices" - ], - "signature": [ - "number | undefined" - ], + "description": ["Total size in bytes among all the identified indices"], + "signature": ["number | undefined"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -578,9 +494,7 @@ "type": "Object", "tags": [], "label": "data_stream", - "description": [ - "For data-stream indices. Reporting their details" - ], + "description": ["For data-stream indices. Reporting their details"], "signature": [ "{ dataset?: string | undefined; type?: string | undefined; } | undefined" ], @@ -594,12 +508,8 @@ "type": "Object", "tags": [], "label": "package", - "description": [ - "When available, reporting the package details" - ], - "signature": [ - "{ name: string; } | undefined" - ], + "description": ["When available, reporting the package details"], + "signature": ["{ name: string; } | undefined"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -613,9 +523,7 @@ "description": [ "What's the process indexing the data? (i.e.: \"beats\", \"logstash\")" ], - "signature": [ - "string | undefined" - ], + "signature": ["string | undefined"], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, "trackAdoption": false @@ -669,9 +577,7 @@ "type": "string", "tags": [], "label": "node_id", - "description": [ - "\nThe Node ID as reported by ES" - ], + "description": ["\nThe Node ID as reported by ES"], "path": "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts", "deprecated": false, "trackAdoption": false @@ -741,9 +647,7 @@ "type": "Interface", "tags": [], "label": "TelemetryPluginSetup", - "description": [ - "\nServer's setup exposed APIs by the telemetry plugin" - ], + "description": ["\nServer's setup exposed APIs by the telemetry plugin"], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -757,11 +661,7 @@ "description": [ "\nResolves into the telemetry Url used to send telemetry.\nThe url is wrapped with node's [URL constructor](https://nodejs.org/api/url.html)." ], - "signature": [ - "() => Promise<", - "URL", - ">" - ], + "signature": ["() => Promise<", "URL", ">"], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -778,9 +678,7 @@ "type": "Interface", "tags": [], "label": "TelemetryPluginStart", - "description": [ - "\nServer's start exposed APIs by the telemetry plugin" - ], + "description": ["\nServer's start exposed APIs by the telemetry plugin"], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, "trackAdoption": false, @@ -789,16 +687,12 @@ "parentPluginId": "telemetry", "id": "def-server.TelemetryPluginStart.getIsOptedIn", "type": "Function", - "tags": [ - "track-adoption" - ], + "tags": ["track-adoption"], "label": "getIsOptedIn", "description": [ "\nResolves `true` if sending usage to Elastic is enabled.\nResolves `false` if the user explicitly opted out of sending usage data to Elastic\nor did not choose to opt-in or out -yet- after a minor or major upgrade (only when previously opted-out).\n" ], - "signature": [ - "() => Promise" - ], + "signature": ["() => Promise"], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, "trackAdoption": true, @@ -817,7 +711,7 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/telemetry/sender.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/telemetry/sender.ts" }, { "plugin": "fleet", @@ -829,11 +723,11 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/telemetry/sender.test.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/telemetry/sender.test.ts" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/telemetry/sender.test.ts" + "path": "x-pack/plugins/observability_solution/synthetics/server/telemetry/sender.test.ts" }, { "plugin": "securitySolution", @@ -856,4 +750,4 @@ "misc": [], "objects": [] } -} \ No newline at end of file +} diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 3eccd4beaeda..30ae9189f949 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -161,7 +161,7 @@ by the user. The final output of the expression pipeline can be rendered using one of the *renderers* registered in `expressions` plugin. All the arguments to expression functions need to be serializable, as well as input and output. -Expression functions should try to stay 'pure'. This makes functions easy to reuse and also +Expression functions should try to stay 'pure'. This makes functions easy to reuse and also make it possible to serialize the whole chain as well as output at every step of execution. It is possible to add comments to expressions by starting them with a `//` sequence @@ -809,7 +809,7 @@ routes, etc. |The stack_connectors plugin provides connector types shipped with Kibana, built on top of the framework provided in the actions plugin. -|{kib-repo}blob/{branch}/x-pack/plugins/synthetics/README.md[synthetics] +|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/synthetics/README.md[synthetics] |The purpose of this plugin is to provide users of Heartbeat more visibility of what's happening in their infrastructure. diff --git a/package.json b/package.json index 45dac58cc719..5223124ab4d0 100644 --- a/package.json +++ b/package.json @@ -787,7 +787,7 @@ "@kbn/status-plugin-a-plugin": "link:test/server_integration/plugins/status_plugin_a", "@kbn/status-plugin-b-plugin": "link:test/server_integration/plugins/status_plugin_b", "@kbn/std": "link:packages/kbn-std", - "@kbn/synthetics-plugin": "link:x-pack/plugins/synthetics", + "@kbn/synthetics-plugin": "link:x-pack/plugins/observability_solution/synthetics", "@kbn/task-manager-fixture-plugin": "link:x-pack/test/alerting_api_integration/common/plugins/task_manager_fixture", "@kbn/task-manager-performance-plugin": "link:x-pack/test/plugin_api_perf/plugins/task_manager_performance", "@kbn/task-manager-plugin": "link:x-pack/plugins/task_manager", diff --git a/packages/kbn-babel-preset/styled_components_files.js b/packages/kbn-babel-preset/styled_components_files.js index 49f96c9c67f7..cac46da53e46 100644 --- a/packages/kbn-babel-preset/styled_components_files.js +++ b/packages/kbn-babel-preset/styled_components_files.js @@ -14,7 +14,7 @@ module.exports = { USES_STYLED_COMPONENTS: [ /packages[\/\\]kbn-ui-shared-deps-(npm|src)[\/\\]/, /src[\/\\]plugins[\/\\](kibana_react)[\/\\]/, - /x-pack[\/\\]plugins[\/\\](apm|beats_management|cases|fleet|infra|lists|observability|observability_shared|exploratory_view|security_solution|timelines|synthetics|ux|uptime)[\/\\]/, + /x-pack[\/\\]plugins[\/\\](apm|beats_management|cases|fleet|infra|lists|observability|observability_shared|exploratory_view|security_solution|timelines|observability_solution\/synthetics|ux|uptime)[\/\\]/, /x-pack[\/\\]test[\/\\]plugin_functional[\/\\]plugins[\/\\]resolver_test[\/\\]/, /x-pack[\/\\]packages[\/\\]elastic_assistant[\/\\]/, /x-pack[\/\\]packages[\/\\]security-solution[\/\\]ecs_data_quality_dashboard[\/\\]/, diff --git a/packages/kbn-eslint-plugin-i18n/helpers/get_i18n_identifier_from_file_path.test.ts b/packages/kbn-eslint-plugin-i18n/helpers/get_i18n_identifier_from_file_path.test.ts index cea9fa1c333d..8edc5c59b099 100644 --- a/packages/kbn-eslint-plugin-i18n/helpers/get_i18n_identifier_from_file_path.test.ts +++ b/packages/kbn-eslint-plugin-i18n/helpers/get_i18n_identifier_from_file_path.test.ts @@ -15,7 +15,7 @@ const testMap = [ ['x-pack/plugins/apm/common/components/app/correlations/correlations_table.tsx', 'xpack.apm'], ['x-pack/plugins/cases/server/components/foo.tsx', 'xpack.cases'], [ - 'x-pack/plugins/synthetics/public/apps/synthetics/components/alerts/toggle_alert_flyout_button.tsx', + 'x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/alerts/toggle_alert_flyout_button.tsx', 'xpack.synthetics', ], ['src/plugins/vis_types/gauge/public/editor/collections.ts', 'visTypeGauge'], diff --git a/tsconfig.base.json b/tsconfig.base.json index 1a54c368d534..e55a6c93ed3d 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -1574,8 +1574,8 @@ "@kbn/stdio-dev-helpers/*": ["packages/kbn-stdio-dev-helpers/*"], "@kbn/storybook": ["packages/kbn-storybook"], "@kbn/storybook/*": ["packages/kbn-storybook/*"], - "@kbn/synthetics-plugin": ["x-pack/plugins/synthetics"], - "@kbn/synthetics-plugin/*": ["x-pack/plugins/synthetics/*"], + "@kbn/synthetics-plugin": ["x-pack/plugins/observability_solution/synthetics"], + "@kbn/synthetics-plugin/*": ["x-pack/plugins/observability_solution/synthetics/*"], "@kbn/task-manager-fixture-plugin": ["x-pack/test/alerting_api_integration/common/plugins/task_manager_fixture"], "@kbn/task-manager-fixture-plugin/*": ["x-pack/test/alerting_api_integration/common/plugins/task_manager_fixture/*"], "@kbn/task-manager-performance-plugin": ["x-pack/test/plugin_api_perf/plugins/task_manager_performance"], diff --git a/x-pack/.i18nrc.json b/x-pack/.i18nrc.json index 53068575a362..01b06437906a 100644 --- a/x-pack/.i18nrc.json +++ b/x-pack/.i18nrc.json @@ -98,7 +98,7 @@ "xpack.transform": "plugins/transform", "xpack.triggersActionsUI": "plugins/triggers_actions_ui", "xpack.upgradeAssistant": "plugins/upgrade_assistant", - "xpack.synthetics": ["plugins/synthetics"], + "xpack.synthetics": ["plugins/observability_solution/synthetics"], "xpack.ux": ["plugins/ux"], "xpack.uptime": ["plugins/uptime"], "xpack.urlDrilldown": "plugins/drilldowns/url_drilldown", diff --git a/x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.sh b/x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.sh index eda340780363..58c2c88a8d83 100755 --- a/x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.sh +++ b/x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.sh @@ -5,4 +5,4 @@ set -euo pipefail UUID="$(cat /proc/sys/kernel/random/uuid)" export UUID -node x-pack/plugins/synthetics/.buildkite/pipelines/flaky.js | buildkite-agent pipeline upload +node x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.js | buildkite-agent pipeline upload diff --git a/x-pack/plugins/observability_solution/synthetics/README.md b/x-pack/plugins/observability_solution/synthetics/README.md index afb3309e788e..bdc078e8607d 100644 --- a/x-pack/plugins/observability_solution/synthetics/README.md +++ b/x-pack/plugins/observability_solution/synthetics/README.md @@ -45,7 +45,7 @@ There's also a `rest_api` folder that defines the structure of the RESTful API e Documentation: https://www.elastic.co/guide/en/kibana/current/development-tests.html#_unit_testing ``` -yarn test:jest x-pack/plugins/synthetics +yarn test:jest x-pack/plugins/observability_solution/synthetics ``` ### Functional tests diff --git a/x-pack/plugins/observability_solution/synthetics/e2e/README.md b/x-pack/plugins/observability_solution/synthetics/e2e/README.md index 72a873e6986f..e8bf7414b70d 100644 --- a/x-pack/plugins/observability_solution/synthetics/e2e/README.md +++ b/x-pack/plugins/observability_solution/synthetics/e2e/README.md @@ -5,7 +5,7 @@ script for standing up the test server. ### Start the server -From `~/x-pack/plugins/synthetics/scripts`, run `node e2e.js --server`. Wait for the server to startup. It will provide you +From `~/x-pack/plugins/observability_solution/synthetics/scripts`, run `node e2e.js --server`. Wait for the server to startup. It will provide you with an example run command when it finishes. ### Run the tests @@ -22,7 +22,7 @@ script for standing up the test server. ### Start the server -From `~/x-pack/plugins/synthetics/scripts`, run `node uptime_e2e.js --server`. Wait for the server to startup. It will provide you +From `~/x-pack/plugins/observability_solution/synthetics/scripts`, run `node uptime_e2e.js --server`. Wait for the server to startup. It will provide you with an example run command when it finishes. ### Run the tests diff --git a/x-pack/plugins/observability_solution/synthetics/jest.config.js b/x-pack/plugins/observability_solution/synthetics/jest.config.js index 6bd70220523d..1ae53b847be2 100644 --- a/x-pack/plugins/observability_solution/synthetics/jest.config.js +++ b/x-pack/plugins/observability_solution/synthetics/jest.config.js @@ -8,8 +8,11 @@ module.exports = { preset: '@kbn/test', rootDir: '../../../..', - roots: ['/x-pack/plugins/synthetics'], - coverageDirectory: '/target/kibana-coverage/jest/x-pack/plugins/synthetics', + roots: ['/x-pack/plugins/observability_solution/synthetics'], + coverageDirectory: + '/target/kibana-coverage/jest/x-pack/plugins/observability_solution/synthetics', coverageReporters: ['text', 'html'], - collectCoverageFrom: ['/x-pack/plugins/synthetics/{common,public,server}/**/*.{ts,tsx}'], + collectCoverageFrom: [ + '/x-pack/plugins/observability_solution/synthetics/{common,public,server}/**/*.{ts,tsx}', + ], }; diff --git a/x-pack/plugins/uptime/.buildkite/pipelines/flaky.sh b/x-pack/plugins/uptime/.buildkite/pipelines/flaky.sh index eda340780363..58c2c88a8d83 100755 --- a/x-pack/plugins/uptime/.buildkite/pipelines/flaky.sh +++ b/x-pack/plugins/uptime/.buildkite/pipelines/flaky.sh @@ -5,4 +5,4 @@ set -euo pipefail UUID="$(cat /proc/sys/kernel/random/uuid)" export UUID -node x-pack/plugins/synthetics/.buildkite/pipelines/flaky.js | buildkite-agent pipeline upload +node x-pack/plugins/observability_solution/synthetics/.buildkite/pipelines/flaky.js | buildkite-agent pipeline upload diff --git a/x-pack/plugins/uptime/README.md b/x-pack/plugins/uptime/README.md index afb3309e788e..bdc078e8607d 100644 --- a/x-pack/plugins/uptime/README.md +++ b/x-pack/plugins/uptime/README.md @@ -45,7 +45,7 @@ There's also a `rest_api` folder that defines the structure of the RESTful API e Documentation: https://www.elastic.co/guide/en/kibana/current/development-tests.html#_unit_testing ``` -yarn test:jest x-pack/plugins/synthetics +yarn test:jest x-pack/plugins/observability_solution/synthetics ``` ### Functional tests diff --git a/x-pack/plugins/uptime/e2e/README.md b/x-pack/plugins/uptime/e2e/README.md index 9a7617cd3d05..ab7ebdf591d8 100644 --- a/x-pack/plugins/uptime/e2e/README.md +++ b/x-pack/plugins/uptime/e2e/README.md @@ -5,7 +5,7 @@ script for standing up the test server. ### Start the server -From `~/x-pack/plugins/synthetics/scripts`, run `node e2e.js --server`. Wait for the server to startup. It will provide you +From `~/x-pack/plugins/observability_solution/synthetics/scripts`, run `node e2e.js --server`. Wait for the server to startup. It will provide you with an example run command when it finishes. ### Run the tests @@ -22,7 +22,7 @@ script for standing up the test server. ### Start the server -From `~/x-pack/plugins/synthetics/scripts`, run `node uptime_e2e.js --server`. Wait for the server to startup. It will provide you +From `~/x-pack/plugins/observability_solution/synthetics/scripts`, run `node uptime_e2e.js --server`. Wait for the server to startup. It will provide you with an example run command when it finishes. ### Run the tests diff --git a/yarn.lock b/yarn.lock index 78cae58ed3d6..5a4065f66128 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6217,7 +6217,7 @@ version "0.0.0" uid "" -"@kbn/synthetics-plugin@link:x-pack/plugins/synthetics": +"@kbn/synthetics-plugin@link:x-pack/plugins/observability_solution/synthetics": version "0.0.0" uid ""